@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AmazonSimpleEmailServiceV2
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAmazonSimpleEmailServiceV2 instead.
Amazon SES is an Amazon Web Services service that you can use to send email messages to your customers.
If you're new to Amazon SES API v2, you might find it helpful to review the Amazon Simple Email Service Developer Guide. The Amazon SES Developer Guide provides information and code samples that demonstrate how to use Amazon SES API v2 features programmatically.
| 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 |
|---|---|
BatchGetMetricDataResult |
batchGetMetricData(BatchGetMetricDataRequest batchGetMetricDataRequest)
Retrieves batches of metric data collected based on your sending activity.
|
CancelExportJobResult |
cancelExportJob(CancelExportJobRequest cancelExportJobRequest)
Cancels an export job.
|
CreateConfigurationSetResult |
createConfigurationSet(CreateConfigurationSetRequest createConfigurationSetRequest)
Create a configuration set.
|
CreateConfigurationSetEventDestinationResult |
createConfigurationSetEventDestination(CreateConfigurationSetEventDestinationRequest createConfigurationSetEventDestinationRequest)
Create an event destination.
|
CreateContactResult |
createContact(CreateContactRequest createContactRequest)
Creates a contact, which is an end-user who is receiving the email, and adds them to a contact list.
|
CreateContactListResult |
createContactList(CreateContactListRequest createContactListRequest)
Creates a contact list.
|
CreateCustomVerificationEmailTemplateResult |
createCustomVerificationEmailTemplate(CreateCustomVerificationEmailTemplateRequest createCustomVerificationEmailTemplateRequest)
Creates a new custom verification email template.
|
CreateDedicatedIpPoolResult |
createDedicatedIpPool(CreateDedicatedIpPoolRequest createDedicatedIpPoolRequest)
Create a new pool of dedicated IP addresses.
|
CreateDeliverabilityTestReportResult |
createDeliverabilityTestReport(CreateDeliverabilityTestReportRequest createDeliverabilityTestReportRequest)
Create a new predictive inbox placement test.
|
CreateEmailIdentityResult |
createEmailIdentity(CreateEmailIdentityRequest createEmailIdentityRequest)
Starts the process of verifying an email identity.
|
CreateEmailIdentityPolicyResult |
createEmailIdentityPolicy(CreateEmailIdentityPolicyRequest createEmailIdentityPolicyRequest)
Creates the specified sending authorization policy for the given identity (an email address or a domain).
|
CreateEmailTemplateResult |
createEmailTemplate(CreateEmailTemplateRequest createEmailTemplateRequest)
Creates an email template.
|
CreateExportJobResult |
createExportJob(CreateExportJobRequest createExportJobRequest)
Creates an export job for a data source and destination.
|
CreateImportJobResult |
createImportJob(CreateImportJobRequest createImportJobRequest)
Creates an import job for a data destination.
|
DeleteConfigurationSetResult |
deleteConfigurationSet(DeleteConfigurationSetRequest deleteConfigurationSetRequest)
Delete an existing configuration set.
|
DeleteConfigurationSetEventDestinationResult |
deleteConfigurationSetEventDestination(DeleteConfigurationSetEventDestinationRequest deleteConfigurationSetEventDestinationRequest)
Delete an event destination.
|
DeleteContactResult |
deleteContact(DeleteContactRequest deleteContactRequest)
Removes a contact from a contact list.
|
DeleteContactListResult |
deleteContactList(DeleteContactListRequest deleteContactListRequest)
Deletes a contact list and all of the contacts on that list.
|
DeleteCustomVerificationEmailTemplateResult |
deleteCustomVerificationEmailTemplate(DeleteCustomVerificationEmailTemplateRequest deleteCustomVerificationEmailTemplateRequest)
Deletes an existing custom verification email template.
|
DeleteDedicatedIpPoolResult |
deleteDedicatedIpPool(DeleteDedicatedIpPoolRequest deleteDedicatedIpPoolRequest)
Delete a dedicated IP pool.
|
DeleteEmailIdentityResult |
deleteEmailIdentity(DeleteEmailIdentityRequest deleteEmailIdentityRequest)
Deletes an email identity.
|
DeleteEmailIdentityPolicyResult |
deleteEmailIdentityPolicy(DeleteEmailIdentityPolicyRequest deleteEmailIdentityPolicyRequest)
Deletes the specified sending authorization policy for the given identity (an email address or a domain).
|
DeleteEmailTemplateResult |
deleteEmailTemplate(DeleteEmailTemplateRequest deleteEmailTemplateRequest)
Deletes an email template.
|
DeleteSuppressedDestinationResult |
deleteSuppressedDestination(DeleteSuppressedDestinationRequest deleteSuppressedDestinationRequest)
Removes an email address from the suppression list for your account.
|
GetAccountResult |
getAccount(GetAccountRequest getAccountRequest)
Obtain information about the email-sending status and capabilities of your Amazon SES account in the current
Amazon Web Services Region.
|
GetBlacklistReportsResult |
getBlacklistReports(GetBlacklistReportsRequest getBlacklistReportsRequest)
Retrieve a list of the blacklists that your dedicated IP addresses appear on.
|
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.
|
GetConfigurationSetResult |
getConfigurationSet(GetConfigurationSetRequest getConfigurationSetRequest)
Get information about an existing configuration set, including the dedicated IP pool that it's associated with,
whether or not it's enabled for sending email, and more.
|
GetConfigurationSetEventDestinationsResult |
getConfigurationSetEventDestinations(GetConfigurationSetEventDestinationsRequest getConfigurationSetEventDestinationsRequest)
Retrieve a list of event destinations that are associated with a configuration set.
|
GetContactResult |
getContact(GetContactRequest getContactRequest)
Returns a contact from a contact list.
|
GetContactListResult |
getContactList(GetContactListRequest getContactListRequest)
Returns contact list metadata.
|
GetCustomVerificationEmailTemplateResult |
getCustomVerificationEmailTemplate(GetCustomVerificationEmailTemplateRequest getCustomVerificationEmailTemplateRequest)
Returns the custom email verification template for the template name you specify.
|
GetDedicatedIpResult |
getDedicatedIp(GetDedicatedIpRequest getDedicatedIpRequest)
Get information about a dedicated IP address, including the name of the dedicated IP pool that it's associated
with, as well information about the automatic warm-up process for the address.
|
GetDedicatedIpPoolResult |
getDedicatedIpPool(GetDedicatedIpPoolRequest getDedicatedIpPoolRequest)
Retrieve information about the dedicated pool.
|
GetDedicatedIpsResult |
getDedicatedIps(GetDedicatedIpsRequest getDedicatedIpsRequest)
List the dedicated IP addresses that are associated with your Amazon Web Services account.
|
GetDeliverabilityDashboardOptionsResult |
getDeliverabilityDashboardOptions(GetDeliverabilityDashboardOptionsRequest getDeliverabilityDashboardOptionsRequest)
Retrieve information about the status of the Deliverability dashboard for your account.
|
GetDeliverabilityTestReportResult |
getDeliverabilityTestReport(GetDeliverabilityTestReportRequest getDeliverabilityTestReportRequest)
Retrieve the results of a predictive inbox placement test.
|
GetDomainDeliverabilityCampaignResult |
getDomainDeliverabilityCampaign(GetDomainDeliverabilityCampaignRequest getDomainDeliverabilityCampaignRequest)
Retrieve all the deliverability data for a specific campaign.
|
GetDomainStatisticsReportResult |
getDomainStatisticsReport(GetDomainStatisticsReportRequest getDomainStatisticsReportRequest)
Retrieve inbox placement and engagement rates for the domains that you use to send email.
|
GetEmailIdentityResult |
getEmailIdentity(GetEmailIdentityRequest getEmailIdentityRequest)
Provides information about a specific identity, including the identity's verification status, sending
authorization policies, its DKIM authentication status, and its custom Mail-From settings.
|
GetEmailIdentityPoliciesResult |
getEmailIdentityPolicies(GetEmailIdentityPoliciesRequest getEmailIdentityPoliciesRequest)
Returns the requested sending authorization policies for the given identity (an email address or a domain).
|
GetEmailTemplateResult |
getEmailTemplate(GetEmailTemplateRequest getEmailTemplateRequest)
Displays the template object (which includes the subject line, HTML part and text part) for the template you
specify.
|
GetExportJobResult |
getExportJob(GetExportJobRequest getExportJobRequest)
Provides information about an export job.
|
GetImportJobResult |
getImportJob(GetImportJobRequest getImportJobRequest)
Provides information about an import job.
|
GetMessageInsightsResult |
getMessageInsights(GetMessageInsightsRequest getMessageInsightsRequest)
Provides information about a specific message, including the from address, the subject, the recipient address,
email tags, as well as events associated with the message.
|
GetSuppressedDestinationResult |
getSuppressedDestination(GetSuppressedDestinationRequest getSuppressedDestinationRequest)
Retrieves information about a specific email address that's on the suppression list for your account.
|
ListConfigurationSetsResult |
listConfigurationSets(ListConfigurationSetsRequest listConfigurationSetsRequest)
List all of the configuration sets associated with your account in the current region.
|
ListContactListsResult |
listContactLists(ListContactListsRequest listContactListsRequest)
Lists all of the contact lists available.
|
ListContactsResult |
listContacts(ListContactsRequest listContactsRequest)
Lists the contacts present in a specific contact list.
|
ListCustomVerificationEmailTemplatesResult |
listCustomVerificationEmailTemplates(ListCustomVerificationEmailTemplatesRequest listCustomVerificationEmailTemplatesRequest)
Lists the existing custom verification email templates for your account in the current Amazon Web Services
Region.
|
ListDedicatedIpPoolsResult |
listDedicatedIpPools(ListDedicatedIpPoolsRequest listDedicatedIpPoolsRequest)
List all of the dedicated IP pools that exist in your Amazon Web Services account in the current Region.
|
ListDeliverabilityTestReportsResult |
listDeliverabilityTestReports(ListDeliverabilityTestReportsRequest listDeliverabilityTestReportsRequest)
Show a list of the predictive inbox placement tests that you've performed, regardless of their statuses.
|
ListDomainDeliverabilityCampaignsResult |
listDomainDeliverabilityCampaigns(ListDomainDeliverabilityCampaignsRequest listDomainDeliverabilityCampaignsRequest)
Retrieve deliverability data for all the campaigns that used a specific domain to send email during a specified
time range.
|
ListEmailIdentitiesResult |
listEmailIdentities(ListEmailIdentitiesRequest listEmailIdentitiesRequest)
Returns a list of all of the email identities that are associated with your Amazon Web Services account.
|
ListEmailTemplatesResult |
listEmailTemplates(ListEmailTemplatesRequest listEmailTemplatesRequest)
Lists the email templates present in your Amazon SES account in the current Amazon Web Services Region.
|
ListExportJobsResult |
listExportJobs(ListExportJobsRequest listExportJobsRequest)
Lists all of the export jobs.
|
ListImportJobsResult |
listImportJobs(ListImportJobsRequest listImportJobsRequest)
Lists all of the import jobs.
|
ListRecommendationsResult |
listRecommendations(ListRecommendationsRequest listRecommendationsRequest)
Lists the recommendations present in your Amazon SES account in the current Amazon Web Services Region.
|
ListSuppressedDestinationsResult |
listSuppressedDestinations(ListSuppressedDestinationsRequest listSuppressedDestinationsRequest)
Retrieves a list of email addresses that are on the suppression list for your account.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Retrieve a list of the tags (keys and values) that are associated with a specified resource.
|
PutAccountDedicatedIpWarmupAttributesResult |
putAccountDedicatedIpWarmupAttributes(PutAccountDedicatedIpWarmupAttributesRequest putAccountDedicatedIpWarmupAttributesRequest)
Enable or disable the automatic warm-up feature for dedicated IP addresses.
|
PutAccountDetailsResult |
putAccountDetails(PutAccountDetailsRequest putAccountDetailsRequest)
Update your Amazon SES account details.
|
PutAccountSendingAttributesResult |
putAccountSendingAttributes(PutAccountSendingAttributesRequest putAccountSendingAttributesRequest)
Enable or disable the ability of your account to send email.
|
PutAccountSuppressionAttributesResult |
putAccountSuppressionAttributes(PutAccountSuppressionAttributesRequest putAccountSuppressionAttributesRequest)
Change the settings for the account-level suppression list.
|
PutAccountVdmAttributesResult |
putAccountVdmAttributes(PutAccountVdmAttributesRequest putAccountVdmAttributesRequest)
Update your Amazon SES account VDM attributes.
|
PutConfigurationSetDeliveryOptionsResult |
putConfigurationSetDeliveryOptions(PutConfigurationSetDeliveryOptionsRequest putConfigurationSetDeliveryOptionsRequest)
Associate a configuration set with a dedicated IP pool.
|
PutConfigurationSetReputationOptionsResult |
putConfigurationSetReputationOptions(PutConfigurationSetReputationOptionsRequest putConfigurationSetReputationOptionsRequest)
Enable or disable collection of reputation metrics for emails that you send using a particular configuration set
in a specific Amazon Web Services Region.
|
PutConfigurationSetSendingOptionsResult |
putConfigurationSetSendingOptions(PutConfigurationSetSendingOptionsRequest putConfigurationSetSendingOptionsRequest)
Enable or disable email sending for messages that use a particular configuration set in a specific Amazon Web
Services Region.
|
PutConfigurationSetSuppressionOptionsResult |
putConfigurationSetSuppressionOptions(PutConfigurationSetSuppressionOptionsRequest putConfigurationSetSuppressionOptionsRequest)
Specify the account suppression list preferences for a configuration set.
|
PutConfigurationSetTrackingOptionsResult |
putConfigurationSetTrackingOptions(PutConfigurationSetTrackingOptionsRequest putConfigurationSetTrackingOptionsRequest)
Specify a custom domain to use for open and click tracking elements in email that you send.
|
PutConfigurationSetVdmOptionsResult |
putConfigurationSetVdmOptions(PutConfigurationSetVdmOptionsRequest putConfigurationSetVdmOptionsRequest)
Specify VDM preferences for email that you send using the configuration set.
|
PutDedicatedIpInPoolResult |
putDedicatedIpInPool(PutDedicatedIpInPoolRequest putDedicatedIpInPoolRequest)
Move a dedicated IP address to an existing dedicated IP pool.
|
PutDedicatedIpPoolScalingAttributesResult |
putDedicatedIpPoolScalingAttributes(PutDedicatedIpPoolScalingAttributesRequest putDedicatedIpPoolScalingAttributesRequest)
Used to convert a dedicated IP pool to a different scaling mode.
|
PutDedicatedIpWarmupAttributesResult |
putDedicatedIpWarmupAttributes(PutDedicatedIpWarmupAttributesRequest putDedicatedIpWarmupAttributesRequest)
|
PutDeliverabilityDashboardOptionResult |
putDeliverabilityDashboardOption(PutDeliverabilityDashboardOptionRequest putDeliverabilityDashboardOptionRequest)
Enable or disable the Deliverability dashboard.
|
PutEmailIdentityConfigurationSetAttributesResult |
putEmailIdentityConfigurationSetAttributes(PutEmailIdentityConfigurationSetAttributesRequest putEmailIdentityConfigurationSetAttributesRequest)
Used to associate a configuration set with an email identity.
|
PutEmailIdentityDkimAttributesResult |
putEmailIdentityDkimAttributes(PutEmailIdentityDkimAttributesRequest putEmailIdentityDkimAttributesRequest)
Used to enable or disable DKIM authentication for an email identity.
|
PutEmailIdentityDkimSigningAttributesResult |
putEmailIdentityDkimSigningAttributes(PutEmailIdentityDkimSigningAttributesRequest putEmailIdentityDkimSigningAttributesRequest)
Used to configure or change the DKIM authentication settings for an email domain identity.
|
PutEmailIdentityFeedbackAttributesResult |
putEmailIdentityFeedbackAttributes(PutEmailIdentityFeedbackAttributesRequest putEmailIdentityFeedbackAttributesRequest)
Used to enable or disable feedback forwarding for an identity.
|
PutEmailIdentityMailFromAttributesResult |
putEmailIdentityMailFromAttributes(PutEmailIdentityMailFromAttributesRequest putEmailIdentityMailFromAttributesRequest)
Used to enable or disable the custom Mail-From domain configuration for an email identity.
|
PutSuppressedDestinationResult |
putSuppressedDestination(PutSuppressedDestinationRequest putSuppressedDestinationRequest)
Adds an email address to the suppression list for your account.
|
SendBulkEmailResult |
sendBulkEmail(SendBulkEmailRequest sendBulkEmailRequest)
Composes an email message to multiple destinations.
|
SendCustomVerificationEmailResult |
sendCustomVerificationEmail(SendCustomVerificationEmailRequest sendCustomVerificationEmailRequest)
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.
|
SendEmailResult |
sendEmail(SendEmailRequest sendEmailRequest)
Sends an email message.
|
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
TagResourceResult |
tagResource(TagResourceRequest tagResourceRequest)
Add one or more tags (keys and values) to a specified resource.
|
TestRenderEmailTemplateResult |
testRenderEmailTemplate(TestRenderEmailTemplateRequest testRenderEmailTemplateRequest)
Creates a preview of the MIME content of an email when provided with a template and a set of replacement data.
|
UntagResourceResult |
untagResource(UntagResourceRequest untagResourceRequest)
Remove one or more tags (keys and values) from a specified resource.
|
UpdateConfigurationSetEventDestinationResult |
updateConfigurationSetEventDestination(UpdateConfigurationSetEventDestinationRequest updateConfigurationSetEventDestinationRequest)
Update the configuration of an event destination for a configuration set.
|
UpdateContactResult |
updateContact(UpdateContactRequest updateContactRequest)
Updates a contact's preferences for a list.
|
UpdateContactListResult |
updateContactList(UpdateContactListRequest updateContactListRequest)
Updates contact list metadata.
|
UpdateCustomVerificationEmailTemplateResult |
updateCustomVerificationEmailTemplate(UpdateCustomVerificationEmailTemplateRequest updateCustomVerificationEmailTemplateRequest)
Updates an existing custom verification email template.
|
UpdateEmailIdentityPolicyResult |
updateEmailIdentityPolicy(UpdateEmailIdentityPolicyRequest updateEmailIdentityPolicyRequest)
Updates the specified sending authorization policy for the given identity (an email address or a domain).
|
UpdateEmailTemplateResult |
updateEmailTemplate(UpdateEmailTemplateRequest updateEmailTemplateRequest)
Updates an email template.
|
static final String ENDPOINT_PREFIX
BatchGetMetricDataResult batchGetMetricData(BatchGetMetricDataRequest batchGetMetricDataRequest)
Retrieves batches of metric data collected based on your sending activity.
You can execute this operation no more than 16 times per second, and with at most 160 queries from the batches per second (cumulative).
batchGetMetricDataRequest - Represents a request to retrieve a batch of metric data.BadRequestException - The input you provided is invalid.InternalServiceErrorException - The request couldn't be processed because an error occurred with the Amazon SES API v2.TooManyRequestsException - Too many requests have been made to the operation.NotFoundException - The resource you attempted to access doesn't exist.CancelExportJobResult cancelExportJob(CancelExportJobRequest cancelExportJobRequest)
Cancels an export job.
cancelExportJobRequest - Represents a request to cancel an export job using the export job ID.NotFoundException - The resource you attempted to access doesn't exist.BadRequestException - The input you provided is invalid.TooManyRequestsException - Too many requests have been made to the operation.CreateConfigurationSetResult createConfigurationSet(CreateConfigurationSetRequest createConfigurationSetRequest)
Create a configuration set. Configuration sets are groups of rules that you can apply to the emails that you send. You apply a configuration set to an email by specifying the name of the configuration set when you call the Amazon SES API v2. When you apply a configuration set to an email, all of the rules in that configuration set are applied to the email.
createConfigurationSetRequest - A request to create a configuration set.AlreadyExistsException - The resource specified in your request already exists.NotFoundException - The resource you attempted to access doesn't exist.TooManyRequestsException - Too many requests have been made to the operation.LimitExceededException - There are too many instances of the specified resource type.BadRequestException - The input you provided is invalid.ConcurrentModificationException - The resource is being modified by another operation or thread.CreateConfigurationSetEventDestinationResult createConfigurationSetEventDestination(CreateConfigurationSetEventDestinationRequest createConfigurationSetEventDestinationRequest)
Create an event destination. Events include message sends, deliveries, opens, clicks, bounces, and complaints. Event destinations are places that you can send information about these events to. For example, you can send event data to Amazon EventBridge and associate a rule to send the event to the specified target.
A single configuration set can include more than one event destination.
createConfigurationSetEventDestinationRequest - A request to add an event destination to a configuration set.NotFoundException - The resource you attempted to access doesn't exist.AlreadyExistsException - The resource specified in your request already exists.LimitExceededException - There are too many instances of the specified resource type.TooManyRequestsException - Too many requests have been made to the operation.BadRequestException - The input you provided is invalid.CreateContactResult createContact(CreateContactRequest createContactRequest)
Creates a contact, which is an end-user who is receiving the email, and adds them to a contact list.
createContactRequest - BadRequestException - The input you provided is invalid.TooManyRequestsException - Too many requests have been made to the operation.NotFoundException - The resource you attempted to access doesn't exist.AlreadyExistsException - The resource specified in your request already exists.CreateContactListResult createContactList(CreateContactListRequest createContactListRequest)
Creates a contact list.
createContactListRequest - BadRequestException - The input you provided is invalid.TooManyRequestsException - Too many requests have been made to the operation.AlreadyExistsException - The resource specified in your request already exists.LimitExceededException - There are too many instances of the specified resource type.CreateCustomVerificationEmailTemplateResult createCustomVerificationEmailTemplate(CreateCustomVerificationEmailTemplateRequest createCustomVerificationEmailTemplateRequest)
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.
createCustomVerificationEmailTemplateRequest - Represents a request to create a custom verification email template.BadRequestException - The input you provided is invalid.AlreadyExistsException - The resource specified in your request already exists.NotFoundException - The resource you attempted to access doesn't exist.TooManyRequestsException - Too many requests have been made to the operation.LimitExceededException - There are too many instances of the specified resource type.CreateDedicatedIpPoolResult createDedicatedIpPool(CreateDedicatedIpPoolRequest createDedicatedIpPoolRequest)
Create a new pool of dedicated IP addresses. A pool can include one or more dedicated IP addresses that are associated with your Amazon Web Services account. You can associate a pool with a configuration set. When you send an email that uses that configuration set, the message is sent from one of the addresses in the associated pool.
createDedicatedIpPoolRequest - A request to create a new dedicated IP pool.AlreadyExistsException - The resource specified in your request already exists.LimitExceededException - There are too many instances of the specified resource type.TooManyRequestsException - Too many requests have been made to the operation.BadRequestException - The input you provided is invalid.ConcurrentModificationException - The resource is being modified by another operation or thread.CreateDeliverabilityTestReportResult createDeliverabilityTestReport(CreateDeliverabilityTestReportRequest createDeliverabilityTestReportRequest)
Create a new predictive inbox placement test. Predictive inbox placement tests can help you predict how your
messages will be handled by various email providers around the world. When you perform a predictive inbox
placement test, you provide a sample message that contains the content that you plan to send to your customers.
Amazon SES then sends that message to special email addresses spread across several major email providers. After
about 24 hours, the test is complete, and you can use the GetDeliverabilityTestReport operation to
view the results of the test.
createDeliverabilityTestReportRequest - A request to perform a predictive inbox placement test. Predictive inbox placement tests can help you
predict how your messages will be handled by various email providers around the world. When you perform a
predictive inbox placement test, you provide a sample message that contains the content that you plan to
send to your customers. We send that message to special email addresses spread across several major email
providers around the world. The test takes about 24 hours to complete. When the test is complete, you can
use the GetDeliverabilityTestReport operation to view the results of the test.AccountSuspendedException - The message can't be sent because the account's ability to send email has been permanently restricted.SendingPausedException - The message can't be sent because the account's ability to send email is currently paused.MessageRejectedException - The message can't be sent because it contains invalid content.MailFromDomainNotVerifiedException - The message can't be sent because the sending domain isn't verified.NotFoundException - The resource you attempted to access doesn't exist.TooManyRequestsException - Too many requests have been made to the operation.LimitExceededException - There are too many instances of the specified resource type.BadRequestException - The input you provided is invalid.ConcurrentModificationException - The resource is being modified by another operation or thread.CreateEmailIdentityResult createEmailIdentity(CreateEmailIdentityRequest createEmailIdentityRequest)
Starts the process of verifying an email identity. An identity is an email address or domain that you use when you send email. Before you can use an identity to send email, you first have to verify it. By verifying an identity, you demonstrate that you're the owner of the identity, and that you've given Amazon SES API v2 permission to send email from the identity.
When you verify an email address, Amazon SES sends an email to the address. Your email address is verified as soon as you follow the link in the verification email.
When you verify a domain without specifying the DkimSigningAttributes object, this operation
provides a set of DKIM tokens. You can convert these tokens into CNAME records, which you then add to the DNS
configuration for your domain. Your domain is verified when Amazon SES detects these records in the DNS
configuration for your domain. This verification method is known as Easy DKIM.
Alternatively, you can perform the verification process by providing your own public-private key pair. This
verification method is known as Bring Your Own DKIM (BYODKIM). To use BYODKIM, your call to the
CreateEmailIdentity operation has to include the DkimSigningAttributes object. When you
specify this object, you provide a selector (a component of the DNS record name that identifies the public key to
use for DKIM authentication) and a private key.
When you verify a domain, this operation provides a set of DKIM tokens, which you can convert into CNAME tokens. You add these CNAME tokens to the DNS configuration for your domain. Your domain is verified when Amazon SES detects these records in the DNS configuration for your domain. For some DNS providers, it can take 72 hours or more to complete the domain verification process.
Additionally, you can associate an existing configuration set with the email identity that you're verifying.
createEmailIdentityRequest - A request to begin the verification process for an email identity (an email address or domain).AlreadyExistsException - The resource specified in your request already exists.LimitExceededException - There are too many instances of the specified resource type.TooManyRequestsException - Too many requests have been made to the operation.BadRequestException - The input you provided is invalid.ConcurrentModificationException - The resource is being modified by another operation or thread.NotFoundException - The resource you attempted to access doesn't exist.CreateEmailIdentityPolicyResult createEmailIdentityPolicy(CreateEmailIdentityPolicyRequest createEmailIdentityPolicyRequest)
Creates the specified sending authorization policy for the given 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.
You can execute this operation no more than once per second.
createEmailIdentityPolicyRequest - Represents a request to create 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.NotFoundException - The resource you attempted to access doesn't exist.AlreadyExistsException - The resource specified in your request already exists.TooManyRequestsException - Too many requests have been made to the operation.LimitExceededException - There are too many instances of the specified resource type.BadRequestException - The input you provided is invalid.CreateEmailTemplateResult createEmailTemplate(CreateEmailTemplateRequest createEmailTemplateRequest)
Creates an email template. Email templates enable you to send personalized email to one or more destinations in a single API operation. For more information, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
createEmailTemplateRequest - Represents a request to create an email template. For more information, see the Amazon SES
Developer Guide.AlreadyExistsException - The resource specified in your request already exists.TooManyRequestsException - Too many requests have been made to the operation.BadRequestException - The input you provided is invalid.LimitExceededException - There are too many instances of the specified resource type.CreateExportJobResult createExportJob(CreateExportJobRequest createExportJobRequest)
Creates an export job for a data source and destination.
You can execute this operation no more than once per second.
createExportJobRequest - Represents a request to create an export job from a data source to a data destination.BadRequestException - The input you provided is invalid.TooManyRequestsException - Too many requests have been made to the operation.NotFoundException - The resource you attempted to access doesn't exist.LimitExceededException - There are too many instances of the specified resource type.CreateImportJobResult createImportJob(CreateImportJobRequest createImportJobRequest)
Creates an import job for a data destination.
createImportJobRequest - Represents a request to create an import job from a data source for a data destination.BadRequestException - The input you provided is invalid.LimitExceededException - There are too many instances of the specified resource type.TooManyRequestsException - Too many requests have been made to the operation.DeleteConfigurationSetResult deleteConfigurationSet(DeleteConfigurationSetRequest deleteConfigurationSetRequest)
Delete an existing configuration set.
Configuration sets are groups of rules that you can apply to the emails you send. You apply a configuration set to an email by including a reference to the configuration set in the headers of the email. When you apply a configuration set to an email, all of the rules in that configuration set are applied to the email.
deleteConfigurationSetRequest - A request to delete a configuration set.NotFoundException - The resource you attempted to access doesn't exist.TooManyRequestsException - Too many requests have been made to the operation.BadRequestException - The input you provided is invalid.ConcurrentModificationException - The resource is being modified by another operation or thread.DeleteConfigurationSetEventDestinationResult deleteConfigurationSetEventDestination(DeleteConfigurationSetEventDestinationRequest deleteConfigurationSetEventDestinationRequest)
Delete an event destination.
Events include message sends, deliveries, opens, clicks, bounces, and complaints. Event destinations are places that you can send information about these events to. For example, you can send event data to Amazon EventBridge and associate a rule to send the event to the specified target.
deleteConfigurationSetEventDestinationRequest - A request to delete an event destination from a configuration set.NotFoundException - The resource you attempted to access doesn't exist.TooManyRequestsException - Too many requests have been made to the operation.BadRequestException - The input you provided is invalid.DeleteContactResult deleteContact(DeleteContactRequest deleteContactRequest)
Removes a contact from a contact list.
deleteContactRequest - BadRequestException - The input you provided is invalid.TooManyRequestsException - Too many requests have been made to the operation.NotFoundException - The resource you attempted to access doesn't exist.DeleteContactListResult deleteContactList(DeleteContactListRequest deleteContactListRequest)
Deletes a contact list and all of the contacts on that list.
deleteContactListRequest - TooManyRequestsException - Too many requests have been made to the operation.NotFoundException - The resource you attempted to access doesn't exist.BadRequestException - The input you provided is invalid.ConcurrentModificationException - The resource is being modified by another operation or thread.DeleteCustomVerificationEmailTemplateResult deleteCustomVerificationEmailTemplate(DeleteCustomVerificationEmailTemplateRequest deleteCustomVerificationEmailTemplateRequest)
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.
deleteCustomVerificationEmailTemplateRequest - Represents a request to delete an existing custom verification email template.NotFoundException - The resource you attempted to access doesn't exist.TooManyRequestsException - Too many requests have been made to the operation.BadRequestException - The input you provided is invalid.DeleteDedicatedIpPoolResult deleteDedicatedIpPool(DeleteDedicatedIpPoolRequest deleteDedicatedIpPoolRequest)
Delete a dedicated IP pool.
deleteDedicatedIpPoolRequest - A request to delete a dedicated IP pool.NotFoundException - The resource you attempted to access doesn't exist.TooManyRequestsException - Too many requests have been made to the operation.BadRequestException - The input you provided is invalid.ConcurrentModificationException - The resource is being modified by another operation or thread.DeleteEmailIdentityResult deleteEmailIdentity(DeleteEmailIdentityRequest deleteEmailIdentityRequest)
Deletes an email identity. An identity can be either an email address or a domain name.
deleteEmailIdentityRequest - A request to delete an existing email identity. When you delete an identity, you lose the ability to send
email from that identity. You can restore your ability to send email by completing the verification
process for the identity again.NotFoundException - The resource you attempted to access doesn't exist.TooManyRequestsException - Too many requests have been made to the operation.BadRequestException - The input you provided is invalid.ConcurrentModificationException - The resource is being modified by another operation or thread.DeleteEmailIdentityPolicyResult deleteEmailIdentityPolicy(DeleteEmailIdentityPolicyRequest deleteEmailIdentityPolicyRequest)
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.
You can execute this operation no more than once per second.
deleteEmailIdentityPolicyRequest - 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.NotFoundException - The resource you attempted to access doesn't exist.TooManyRequestsException - Too many requests have been made to the operation.BadRequestException - The input you provided is invalid.DeleteEmailTemplateResult deleteEmailTemplate(DeleteEmailTemplateRequest deleteEmailTemplateRequest)
Deletes an email template.
You can execute this operation no more than once per second.
deleteEmailTemplateRequest - Represents a request to delete an email template. For more information, see the Amazon SES
Developer Guide.NotFoundException - The resource you attempted to access doesn't exist.TooManyRequestsException - Too many requests have been made to the operation.BadRequestException - The input you provided is invalid.DeleteSuppressedDestinationResult deleteSuppressedDestination(DeleteSuppressedDestinationRequest deleteSuppressedDestinationRequest)
Removes an email address from the suppression list for your account.
deleteSuppressedDestinationRequest - A request to remove an email address from the suppression list for your account.NotFoundException - The resource you attempted to access doesn't exist.BadRequestException - The input you provided is invalid.TooManyRequestsException - Too many requests have been made to the operation.GetAccountResult getAccount(GetAccountRequest getAccountRequest)
Obtain information about the email-sending status and capabilities of your Amazon SES account in the current Amazon Web Services Region.
getAccountRequest - A request to obtain information about the email-sending capabilities of your Amazon SES account.TooManyRequestsException - Too many requests have been made to the operation.BadRequestException - The input you provided is invalid.GetBlacklistReportsResult getBlacklistReports(GetBlacklistReportsRequest getBlacklistReportsRequest)
Retrieve a list of the blacklists that your dedicated IP addresses appear on.
getBlacklistReportsRequest - A request to retrieve a list of the blacklists that your dedicated IP addresses appear on.TooManyRequestsException - Too many requests have been made to the operation.NotFoundException - The resource you attempted to access doesn't exist.BadRequestException - The input you provided is invalid.GetConfigurationSetResult getConfigurationSet(GetConfigurationSetRequest getConfigurationSetRequest)
Get information about an existing configuration set, including the dedicated IP pool that it's associated with, whether or not it's enabled for sending email, and more.
Configuration sets are groups of rules that you can apply to the emails you send. You apply a configuration set to an email by including a reference to the configuration set in the headers of the email. When you apply a configuration set to an email, all of the rules in that configuration set are applied to the email.
getConfigurationSetRequest - A request to obtain information about a configuration set.NotFoundException - The resource you attempted to access doesn't exist.TooManyRequestsException - Too many requests have been made to the operation.BadRequestException - The input you provided is invalid.GetConfigurationSetEventDestinationsResult getConfigurationSetEventDestinations(GetConfigurationSetEventDestinationsRequest getConfigurationSetEventDestinationsRequest)
Retrieve a list of event destinations that are associated with a configuration set.
Events include message sends, deliveries, opens, clicks, bounces, and complaints. Event destinations are places that you can send information about these events to. For example, you can send event data to Amazon EventBridge and associate a rule to send the event to the specified target.
getConfigurationSetEventDestinationsRequest - A request to obtain information about the event destinations for a configuration set.NotFoundException - The resource you attempted to access doesn't exist.TooManyRequestsException - Too many requests have been made to the operation.BadRequestException - The input you provided is invalid.GetContactResult getContact(GetContactRequest getContactRequest)
Returns a contact from a contact list.
getContactRequest - BadRequestException - The input you provided is invalid.TooManyRequestsException - Too many requests have been made to the operation.NotFoundException - The resource you attempted to access doesn't exist.GetContactListResult getContactList(GetContactListRequest getContactListRequest)
Returns contact list metadata. It does not return any information about the contacts present in the list.
getContactListRequest - TooManyRequestsException - Too many requests have been made to the operation.NotFoundException - The resource you attempted to access doesn't exist.BadRequestException - The input you provided is invalid.GetCustomVerificationEmailTemplateResult getCustomVerificationEmailTemplate(GetCustomVerificationEmailTemplateRequest getCustomVerificationEmailTemplateRequest)
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.
getCustomVerificationEmailTemplateRequest - Represents a request to retrieve an existing custom verification email template.NotFoundException - The resource you attempted to access doesn't exist.TooManyRequestsException - Too many requests have been made to the operation.BadRequestException - The input you provided is invalid.GetDedicatedIpResult getDedicatedIp(GetDedicatedIpRequest getDedicatedIpRequest)
Get information about a dedicated IP address, including the name of the dedicated IP pool that it's associated with, as well information about the automatic warm-up process for the address.
getDedicatedIpRequest - A request to obtain more information about a dedicated IP address.TooManyRequestsException - Too many requests have been made to the operation.NotFoundException - The resource you attempted to access doesn't exist.BadRequestException - The input you provided is invalid.GetDedicatedIpPoolResult getDedicatedIpPool(GetDedicatedIpPoolRequest getDedicatedIpPoolRequest)
Retrieve information about the dedicated pool.
getDedicatedIpPoolRequest - A request to obtain more information about a dedicated IP pool.TooManyRequestsException - Too many requests have been made to the operation.NotFoundException - The resource you attempted to access doesn't exist.BadRequestException - The input you provided is invalid.GetDedicatedIpsResult getDedicatedIps(GetDedicatedIpsRequest getDedicatedIpsRequest)
List the dedicated IP addresses that are associated with your Amazon Web Services account.
getDedicatedIpsRequest - A request to obtain more information about dedicated IP pools.TooManyRequestsException - Too many requests have been made to the operation.NotFoundException - The resource you attempted to access doesn't exist.BadRequestException - The input you provided is invalid.GetDeliverabilityDashboardOptionsResult getDeliverabilityDashboardOptions(GetDeliverabilityDashboardOptionsRequest getDeliverabilityDashboardOptionsRequest)
Retrieve information about the status of the Deliverability dashboard for your account. When the Deliverability dashboard is enabled, you gain access to reputation, deliverability, and other metrics for the domains that you use to send email. You also gain the ability to perform predictive inbox placement tests.
When you use the Deliverability dashboard, you pay a monthly subscription charge, in addition to any other fees that you accrue by using Amazon SES and other Amazon Web Services services. For more information about the features and cost of a Deliverability dashboard subscription, see Amazon SES Pricing.
getDeliverabilityDashboardOptionsRequest - Retrieve information about the status of the Deliverability dashboard for your Amazon Web Services
account. When the Deliverability dashboard is enabled, you gain access to reputation, deliverability, and
other metrics for your domains. You also gain the ability to perform predictive inbox placement tests.
When you use the Deliverability dashboard, you pay a monthly subscription charge, in addition to any other fees that you accrue by using Amazon SES and other Amazon Web Services services. For more information about the features and cost of a Deliverability dashboard subscription, see Amazon Pinpoint Pricing.
TooManyRequestsException - Too many requests have been made to the operation.LimitExceededException - There are too many instances of the specified resource type.BadRequestException - The input you provided is invalid.GetDeliverabilityTestReportResult getDeliverabilityTestReport(GetDeliverabilityTestReportRequest getDeliverabilityTestReportRequest)
Retrieve the results of a predictive inbox placement test.
getDeliverabilityTestReportRequest - A request to retrieve the results of a predictive inbox placement test.TooManyRequestsException - Too many requests have been made to the operation.NotFoundException - The resource you attempted to access doesn't exist.BadRequestException - The input you provided is invalid.GetDomainDeliverabilityCampaignResult getDomainDeliverabilityCampaign(GetDomainDeliverabilityCampaignRequest getDomainDeliverabilityCampaignRequest)
Retrieve all the deliverability data for a specific campaign. This data is available for a campaign only if the campaign sent email by using a domain that the Deliverability dashboard is enabled for.
getDomainDeliverabilityCampaignRequest - Retrieve all the deliverability data for a specific campaign. This data is available for a campaign only
if the campaign sent email by using a domain that the Deliverability dashboard is enabled for (
PutDeliverabilityDashboardOption operation).TooManyRequestsException - Too many requests have been made to the operation.BadRequestException - The input you provided is invalid.NotFoundException - The resource you attempted to access doesn't exist.GetDomainStatisticsReportResult getDomainStatisticsReport(GetDomainStatisticsReportRequest getDomainStatisticsReportRequest)
Retrieve inbox placement and engagement rates for the domains that you use to send email.
getDomainStatisticsReportRequest - A request to obtain deliverability metrics for a domain.TooManyRequestsException - Too many requests have been made to the operation.NotFoundException - The resource you attempted to access doesn't exist.BadRequestException - The input you provided is invalid.GetEmailIdentityResult getEmailIdentity(GetEmailIdentityRequest getEmailIdentityRequest)
Provides information about a specific identity, including the identity's verification status, sending authorization policies, its DKIM authentication status, and its custom Mail-From settings.
getEmailIdentityRequest - A request to return details about an email identity.NotFoundException - The resource you attempted to access doesn't exist.TooManyRequestsException - Too many requests have been made to the operation.BadRequestException - The input you provided is invalid.GetEmailIdentityPoliciesResult getEmailIdentityPolicies(GetEmailIdentityPoliciesRequest getEmailIdentityPoliciesRequest)
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.
You can execute this operation no more than once per second.
getEmailIdentityPoliciesRequest - A request to return the policies of an email identity.NotFoundException - The resource you attempted to access doesn't exist.TooManyRequestsException - Too many requests have been made to the operation.BadRequestException - The input you provided is invalid.GetEmailTemplateResult getEmailTemplate(GetEmailTemplateRequest getEmailTemplateRequest)
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.
getEmailTemplateRequest - Represents a request to display the template object (which includes the subject line, HTML part and text
part) for the template you specify.NotFoundException - The resource you attempted to access doesn't exist.TooManyRequestsException - Too many requests have been made to the operation.BadRequestException - The input you provided is invalid.GetExportJobResult getExportJob(GetExportJobRequest getExportJobRequest)
Provides information about an export job.
getExportJobRequest - Represents a request to retrieve information about an export job using the export job ID.BadRequestException - The input you provided is invalid.NotFoundException - The resource you attempted to access doesn't exist.TooManyRequestsException - Too many requests have been made to the operation.GetImportJobResult getImportJob(GetImportJobRequest getImportJobRequest)
Provides information about an import job.
getImportJobRequest - Represents a request for information about an import job using the import job ID.BadRequestException - The input you provided is invalid.NotFoundException - The resource you attempted to access doesn't exist.TooManyRequestsException - Too many requests have been made to the operation.GetMessageInsightsResult getMessageInsights(GetMessageInsightsRequest getMessageInsightsRequest)
Provides information about a specific message, including the from address, the subject, the recipient address, email tags, as well as events associated with the message.
You can execute this operation no more than once per second.
getMessageInsightsRequest - A request to return information about a message.NotFoundException - The resource you attempted to access doesn't exist.TooManyRequestsException - Too many requests have been made to the operation.BadRequestException - The input you provided is invalid.GetSuppressedDestinationResult getSuppressedDestination(GetSuppressedDestinationRequest getSuppressedDestinationRequest)
Retrieves information about a specific email address that's on the suppression list for your account.
getSuppressedDestinationRequest - A request to retrieve information about an email address that's on the suppression list for your account.BadRequestException - The input you provided is invalid.TooManyRequestsException - Too many requests have been made to the operation.NotFoundException - The resource you attempted to access doesn't exist.ListConfigurationSetsResult listConfigurationSets(ListConfigurationSetsRequest listConfigurationSetsRequest)
List all of the configuration sets associated with your account in the current region.
Configuration sets are groups of rules that you can apply to the emails you send. You apply a configuration set to an email by including a reference to the configuration set in the headers of the email. When you apply a configuration set to an email, all of the rules in that configuration set are applied to the email.
listConfigurationSetsRequest - A request to obtain a list of configuration sets for your Amazon SES account in the current Amazon Web
Services Region.TooManyRequestsException - Too many requests have been made to the operation.BadRequestException - The input you provided is invalid.ListContactListsResult listContactLists(ListContactListsRequest listContactListsRequest)
Lists all of the contact lists available.
listContactListsRequest - BadRequestException - The input you provided is invalid.TooManyRequestsException - Too many requests have been made to the operation.ListContactsResult listContacts(ListContactsRequest listContactsRequest)
Lists the contacts present in a specific contact list.
listContactsRequest - BadRequestException - The input you provided is invalid.TooManyRequestsException - Too many requests have been made to the operation.NotFoundException - The resource you attempted to access doesn't exist.ListCustomVerificationEmailTemplatesResult listCustomVerificationEmailTemplates(ListCustomVerificationEmailTemplatesRequest listCustomVerificationEmailTemplatesRequest)
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.
listCustomVerificationEmailTemplatesRequest - Represents a request to list the existing custom verification email templates for your account.TooManyRequestsException - Too many requests have been made to the operation.BadRequestException - The input you provided is invalid.ListDedicatedIpPoolsResult listDedicatedIpPools(ListDedicatedIpPoolsRequest listDedicatedIpPoolsRequest)
List all of the dedicated IP pools that exist in your Amazon Web Services account in the current Region.
listDedicatedIpPoolsRequest - A request to obtain a list of dedicated IP pools.TooManyRequestsException - Too many requests have been made to the operation.BadRequestException - The input you provided is invalid.ListDeliverabilityTestReportsResult listDeliverabilityTestReports(ListDeliverabilityTestReportsRequest listDeliverabilityTestReportsRequest)
Show a list of the predictive inbox placement tests that you've performed, regardless of their statuses. For
predictive inbox placement tests that are complete, you can use the GetDeliverabilityTestReport
operation to view the results.
listDeliverabilityTestReportsRequest - A request to list all of the predictive inbox placement tests that you've performed.TooManyRequestsException - Too many requests have been made to the operation.NotFoundException - The resource you attempted to access doesn't exist.BadRequestException - The input you provided is invalid.ListDomainDeliverabilityCampaignsResult listDomainDeliverabilityCampaigns(ListDomainDeliverabilityCampaignsRequest listDomainDeliverabilityCampaignsRequest)
Retrieve deliverability data for all the campaigns that used a specific domain to send email during a specified time range. This data is available for a domain only if you enabled the Deliverability dashboard for the domain.
listDomainDeliverabilityCampaignsRequest - Retrieve deliverability data for all the campaigns that used a specific domain to send email during a
specified time range. This data is available for a domain only if you enabled the Deliverability
dashboard.TooManyRequestsException - Too many requests have been made to the operation.BadRequestException - The input you provided is invalid.NotFoundException - The resource you attempted to access doesn't exist.ListEmailIdentitiesResult listEmailIdentities(ListEmailIdentitiesRequest listEmailIdentitiesRequest)
Returns a list of all of the email identities that are associated with your Amazon Web Services account. An identity can be either an email address or a domain. This operation returns identities that are verified as well as those that aren't. This operation returns identities that are associated with Amazon SES and Amazon Pinpoint.
listEmailIdentitiesRequest - A request to list all of the email identities associated with your Amazon Web Services account. This list
includes identities that you've already verified, identities that are unverified, and identities that were
verified in the past, but are no longer verified.TooManyRequestsException - Too many requests have been made to the operation.BadRequestException - The input you provided is invalid.ListEmailTemplatesResult listEmailTemplates(ListEmailTemplatesRequest listEmailTemplatesRequest)
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.
listEmailTemplatesRequest - Represents a request to list the email templates present in your Amazon SES account in the current Amazon
Web Services Region. For more information, see the Amazon SES
Developer Guide.TooManyRequestsException - Too many requests have been made to the operation.BadRequestException - The input you provided is invalid.ListExportJobsResult listExportJobs(ListExportJobsRequest listExportJobsRequest)
Lists all of the export jobs.
listExportJobsRequest - Represents a request to list all export jobs with filters.TooManyRequestsException - Too many requests have been made to the operation.BadRequestException - The input you provided is invalid.ListImportJobsResult listImportJobs(ListImportJobsRequest listImportJobsRequest)
Lists all of the import jobs.
listImportJobsRequest - Represents a request to list all of the import jobs for a data destination within the specified maximum
number of import jobs.TooManyRequestsException - Too many requests have been made to the operation.BadRequestException - The input you provided is invalid.ListRecommendationsResult listRecommendations(ListRecommendationsRequest listRecommendationsRequest)
Lists the recommendations present in your Amazon SES account in the current Amazon Web Services Region.
You can execute this operation no more than once per second.
listRecommendationsRequest - Represents a request to list the existing recommendations for your account.TooManyRequestsException - Too many requests have been made to the operation.BadRequestException - The input you provided is invalid.NotFoundException - The resource you attempted to access doesn't exist.ListSuppressedDestinationsResult listSuppressedDestinations(ListSuppressedDestinationsRequest listSuppressedDestinationsRequest)
Retrieves a list of email addresses that are on the suppression list for your account.
listSuppressedDestinationsRequest - A request to obtain a list of email destinations that are on the suppression list for your account.BadRequestException - The input you provided is invalid.TooManyRequestsException - Too many requests have been made to the operation.InvalidNextTokenException - The specified request includes an invalid or expired token.ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Retrieve a list of the tags (keys and values) that are associated with a specified resource. A tag is a label that you optionally define and associate with a resource. Each tag consists of a required tag key and an optional associated tag value. A tag key is a general label that acts as a category for more specific tag values. A tag value acts as a descriptor within a tag key.
listTagsForResourceRequest - BadRequestException - The input you provided is invalid.NotFoundException - The resource you attempted to access doesn't exist.TooManyRequestsException - Too many requests have been made to the operation.PutAccountDedicatedIpWarmupAttributesResult putAccountDedicatedIpWarmupAttributes(PutAccountDedicatedIpWarmupAttributesRequest putAccountDedicatedIpWarmupAttributesRequest)
Enable or disable the automatic warm-up feature for dedicated IP addresses.
putAccountDedicatedIpWarmupAttributesRequest - A request to enable or disable the automatic IP address warm-up feature.TooManyRequestsException - Too many requests have been made to the operation.BadRequestException - The input you provided is invalid.PutAccountDetailsResult putAccountDetails(PutAccountDetailsRequest putAccountDetailsRequest)
Update your Amazon SES account details.
putAccountDetailsRequest - A request to submit new account details.TooManyRequestsException - Too many requests have been made to the operation.BadRequestException - The input you provided is invalid.ConflictException - If there is already an ongoing account details update under review.PutAccountSendingAttributesResult putAccountSendingAttributes(PutAccountSendingAttributesRequest putAccountSendingAttributesRequest)
Enable or disable the ability of your account to send email.
putAccountSendingAttributesRequest - A request to change the ability of your account to send email.TooManyRequestsException - Too many requests have been made to the operation.BadRequestException - The input you provided is invalid.PutAccountSuppressionAttributesResult putAccountSuppressionAttributes(PutAccountSuppressionAttributesRequest putAccountSuppressionAttributesRequest)
Change the settings for the account-level suppression list.
putAccountSuppressionAttributesRequest - A request to change your account's suppression preferences.TooManyRequestsException - Too many requests have been made to the operation.BadRequestException - The input you provided is invalid.PutAccountVdmAttributesResult putAccountVdmAttributes(PutAccountVdmAttributesRequest putAccountVdmAttributesRequest)
Update your Amazon SES account VDM attributes.
You can execute this operation no more than once per second.
putAccountVdmAttributesRequest - A request to submit new account VDM attributes.BadRequestException - The input you provided is invalid.TooManyRequestsException - Too many requests have been made to the operation.PutConfigurationSetDeliveryOptionsResult putConfigurationSetDeliveryOptions(PutConfigurationSetDeliveryOptionsRequest putConfigurationSetDeliveryOptionsRequest)
Associate a configuration set with a dedicated IP pool. You can use dedicated IP pools to create groups of dedicated IP addresses for sending specific types of email.
putConfigurationSetDeliveryOptionsRequest - A request to associate a configuration set with a dedicated IP pool.NotFoundException - The resource you attempted to access doesn't exist.TooManyRequestsException - Too many requests have been made to the operation.BadRequestException - The input you provided is invalid.PutConfigurationSetReputationOptionsResult putConfigurationSetReputationOptions(PutConfigurationSetReputationOptionsRequest putConfigurationSetReputationOptionsRequest)
Enable or disable collection of reputation metrics for emails that you send using a particular configuration set in a specific Amazon Web Services Region.
putConfigurationSetReputationOptionsRequest - A request to enable or disable tracking of reputation metrics for a configuration set.NotFoundException - The resource you attempted to access doesn't exist.TooManyRequestsException - Too many requests have been made to the operation.BadRequestException - The input you provided is invalid.PutConfigurationSetSendingOptionsResult putConfigurationSetSendingOptions(PutConfigurationSetSendingOptionsRequest putConfigurationSetSendingOptionsRequest)
Enable or disable email sending for messages that use a particular configuration set in a specific Amazon Web Services Region.
putConfigurationSetSendingOptionsRequest - A request to enable or disable the ability of Amazon SES to send emails that use a specific configuration
set.NotFoundException - The resource you attempted to access doesn't exist.TooManyRequestsException - Too many requests have been made to the operation.BadRequestException - The input you provided is invalid.PutConfigurationSetSuppressionOptionsResult putConfigurationSetSuppressionOptions(PutConfigurationSetSuppressionOptionsRequest putConfigurationSetSuppressionOptionsRequest)
Specify the account suppression list preferences for a configuration set.
putConfigurationSetSuppressionOptionsRequest - A request to change the account suppression list preferences for a specific configuration set.NotFoundException - The resource you attempted to access doesn't exist.TooManyRequestsException - Too many requests have been made to the operation.BadRequestException - The input you provided is invalid.PutConfigurationSetTrackingOptionsResult putConfigurationSetTrackingOptions(PutConfigurationSetTrackingOptionsRequest putConfigurationSetTrackingOptionsRequest)
Specify a custom domain to use for open and click tracking elements in email that you send.
putConfigurationSetTrackingOptionsRequest - A request to add a custom domain for tracking open and click events to a configuration set.NotFoundException - The resource you attempted to access doesn't exist.TooManyRequestsException - Too many requests have been made to the operation.BadRequestException - The input you provided is invalid.PutConfigurationSetVdmOptionsResult putConfigurationSetVdmOptions(PutConfigurationSetVdmOptionsRequest putConfigurationSetVdmOptionsRequest)
Specify VDM preferences for email that you send using the configuration set.
You can execute this operation no more than once per second.
putConfigurationSetVdmOptionsRequest - A request to add specific VDM settings to a configuration set.NotFoundException - The resource you attempted to access doesn't exist.TooManyRequestsException - Too many requests have been made to the operation.BadRequestException - The input you provided is invalid.PutDedicatedIpInPoolResult putDedicatedIpInPool(PutDedicatedIpInPoolRequest putDedicatedIpInPoolRequest)
Move a dedicated IP address to an existing dedicated IP pool.
The dedicated IP address that you specify must already exist, and must be associated with your Amazon Web Services account.
The dedicated IP pool you specify must already exist. You can create a new pool by using the
CreateDedicatedIpPool operation.
putDedicatedIpInPoolRequest - A request to move a dedicated IP address to a dedicated IP pool.NotFoundException - The resource you attempted to access doesn't exist.TooManyRequestsException - Too many requests have been made to the operation.BadRequestException - The input you provided is invalid.PutDedicatedIpPoolScalingAttributesResult putDedicatedIpPoolScalingAttributes(PutDedicatedIpPoolScalingAttributesRequest putDedicatedIpPoolScalingAttributesRequest)
Used to convert a dedicated IP pool to a different scaling mode.
MANAGED pools cannot be converted to STANDARD scaling mode.
putDedicatedIpPoolScalingAttributesRequest - A request to convert a dedicated IP pool to a different scaling mode.NotFoundException - The resource you attempted to access doesn't exist.ConcurrentModificationException - The resource is being modified by another operation or thread.TooManyRequestsException - Too many requests have been made to the operation.BadRequestException - The input you provided is invalid.PutDedicatedIpWarmupAttributesResult putDedicatedIpWarmupAttributes(PutDedicatedIpWarmupAttributesRequest putDedicatedIpWarmupAttributesRequest)
putDedicatedIpWarmupAttributesRequest - A request to change the warm-up attributes for a dedicated IP address. This operation is useful when you
want to resume the warm-up process for an existing IP address.NotFoundException - The resource you attempted to access doesn't exist.TooManyRequestsException - Too many requests have been made to the operation.BadRequestException - The input you provided is invalid.PutDeliverabilityDashboardOptionResult putDeliverabilityDashboardOption(PutDeliverabilityDashboardOptionRequest putDeliverabilityDashboardOptionRequest)
Enable or disable the Deliverability dashboard. When you enable the Deliverability dashboard, you gain access to reputation, deliverability, and other metrics for the domains that you use to send email. You also gain the ability to perform predictive inbox placement tests.
When you use the Deliverability dashboard, you pay a monthly subscription charge, in addition to any other fees that you accrue by using Amazon SES and other Amazon Web Services services. For more information about the features and cost of a Deliverability dashboard subscription, see Amazon SES Pricing.
putDeliverabilityDashboardOptionRequest - Enable or disable the Deliverability dashboard. When you enable the Deliverability dashboard, you gain
access to reputation, deliverability, and other metrics for the domains that you use to send email using
Amazon SES API v2. You also gain the ability to perform predictive inbox placement tests.
When you use the Deliverability dashboard, you pay a monthly subscription charge, in addition to any other fees that you accrue by using Amazon SES and other Amazon Web Services services. For more information about the features and cost of a Deliverability dashboard subscription, see Amazon Pinpoint Pricing.
AlreadyExistsException - The resource specified in your request already exists.NotFoundException - The resource you attempted to access doesn't exist.TooManyRequestsException - Too many requests have been made to the operation.LimitExceededException - There are too many instances of the specified resource type.BadRequestException - The input you provided is invalid.PutEmailIdentityConfigurationSetAttributesResult putEmailIdentityConfigurationSetAttributes(PutEmailIdentityConfigurationSetAttributesRequest putEmailIdentityConfigurationSetAttributesRequest)
Used to associate a configuration set with an email identity.
putEmailIdentityConfigurationSetAttributesRequest - A request to associate a configuration set with an email identity.NotFoundException - The resource you attempted to access doesn't exist.TooManyRequestsException - Too many requests have been made to the operation.BadRequestException - The input you provided is invalid.PutEmailIdentityDkimAttributesResult putEmailIdentityDkimAttributes(PutEmailIdentityDkimAttributesRequest putEmailIdentityDkimAttributesRequest)
Used to enable or disable DKIM authentication for an email identity.
putEmailIdentityDkimAttributesRequest - A request to enable or disable DKIM signing of email that you send from an email identity.NotFoundException - The resource you attempted to access doesn't exist.TooManyRequestsException - Too many requests have been made to the operation.BadRequestException - The input you provided is invalid.PutEmailIdentityDkimSigningAttributesResult putEmailIdentityDkimSigningAttributes(PutEmailIdentityDkimSigningAttributesRequest putEmailIdentityDkimSigningAttributesRequest)
Used to configure or change the DKIM authentication settings for an email domain identity. You can use this operation to do any of the following:
Update the signing attributes for an identity that uses Bring Your Own DKIM (BYODKIM).
Update the key length that should be used for Easy DKIM.
Change from using no DKIM authentication to using Easy DKIM.
Change from using no DKIM authentication to using BYODKIM.
Change from using Easy DKIM to using BYODKIM.
Change from using BYODKIM to using Easy DKIM.
putEmailIdentityDkimSigningAttributesRequest - A request to change the DKIM attributes for an email identity.NotFoundException - The resource you attempted to access doesn't exist.TooManyRequestsException - Too many requests have been made to the operation.BadRequestException - The input you provided is invalid.PutEmailIdentityFeedbackAttributesResult putEmailIdentityFeedbackAttributes(PutEmailIdentityFeedbackAttributesRequest putEmailIdentityFeedbackAttributesRequest)
Used to enable or disable feedback forwarding for an identity. This setting determines what happens when an identity is used to send an email that results in a bounce or complaint event.
If the value is true, you receive email notifications when bounce or complaint events occur. These
notifications are sent to the address that you specified in the Return-Path header of the original
email.
You're required to have a method of tracking bounces and complaints. If you haven't set up another mechanism for receiving bounce or complaint notifications (for example, by setting up an event destination), you receive an email notification when these events occur (even if this setting is disabled).
putEmailIdentityFeedbackAttributesRequest - A request to set the attributes that control how bounce and complaint events are processed.NotFoundException - The resource you attempted to access doesn't exist.TooManyRequestsException - Too many requests have been made to the operation.BadRequestException - The input you provided is invalid.PutEmailIdentityMailFromAttributesResult putEmailIdentityMailFromAttributes(PutEmailIdentityMailFromAttributesRequest putEmailIdentityMailFromAttributesRequest)
Used to enable or disable the custom Mail-From domain configuration for an email identity.
putEmailIdentityMailFromAttributesRequest - A request to configure the custom MAIL FROM domain for a verified identity.NotFoundException - The resource you attempted to access doesn't exist.TooManyRequestsException - Too many requests have been made to the operation.BadRequestException - The input you provided is invalid.PutSuppressedDestinationResult putSuppressedDestination(PutSuppressedDestinationRequest putSuppressedDestinationRequest)
Adds an email address to the suppression list for your account.
putSuppressedDestinationRequest - A request to add an email destination to the suppression list for your account.BadRequestException - The input you provided is invalid.TooManyRequestsException - Too many requests have been made to the operation.SendBulkEmailResult sendBulkEmail(SendBulkEmailRequest sendBulkEmailRequest)
Composes an email message to multiple destinations.
sendBulkEmailRequest - Represents a request to send email messages to multiple destinations using Amazon SES. For more
information, see the Amazon SES
Developer Guide.TooManyRequestsException - Too many requests have been made to the operation.LimitExceededException - There are too many instances of the specified resource type.AccountSuspendedException - The message can't be sent because the account's ability to send email has been permanently restricted.SendingPausedException - The message can't be sent because the account's ability to send email is currently paused.MessageRejectedException - The message can't be sent because it contains invalid content.MailFromDomainNotVerifiedException - The message can't be sent because the sending domain isn't verified.NotFoundException - The resource you attempted to access doesn't exist.BadRequestException - The input you provided is invalid.SendCustomVerificationEmailResult sendCustomVerificationEmail(SendCustomVerificationEmailRequest sendCustomVerificationEmailRequest)
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.
sendCustomVerificationEmailRequest - Represents a request to send a custom verification email to a specified recipient.TooManyRequestsException - Too many requests have been made to the operation.LimitExceededException - There are too many instances of the specified resource type.MessageRejectedException - The message can't be sent because it contains invalid content.SendingPausedException - The message can't be sent because the account's ability to send email is currently paused.MailFromDomainNotVerifiedException - The message can't be sent because the sending domain isn't verified.NotFoundException - The resource you attempted to access doesn't exist.BadRequestException - The input you provided is invalid.SendEmailResult sendEmail(SendEmailRequest sendEmailRequest)
Sends an email message. You can use the Amazon SES API v2 to send the following types of messages:
Simple – A standard email message. When you create this type of message, you specify the sender, the recipient, and the message body, and Amazon SES assembles the message for you.
Raw – A raw, MIME-formatted email message. When you send this type of email, you have to specify all of the message headers, as well as the message body. You can use this message type to send messages that contain attachments. The message that you specify has to be a valid MIME message.
Templated – A message that contains personalization tags. When you send this type of email, Amazon SES API v2 automatically replaces the tags with values that you specify.
sendEmailRequest - Represents a request to send a single formatted email using Amazon SES. For more information, see the Amazon SES
Developer Guide.TooManyRequestsException - Too many requests have been made to the operation.LimitExceededException - There are too many instances of the specified resource type.AccountSuspendedException - The message can't be sent because the account's ability to send email has been permanently restricted.SendingPausedException - The message can't be sent because the account's ability to send email is currently paused.MessageRejectedException - The message can't be sent because it contains invalid content.MailFromDomainNotVerifiedException - The message can't be sent because the sending domain isn't verified.NotFoundException - The resource you attempted to access doesn't exist.BadRequestException - The input you provided is invalid.TagResourceResult tagResource(TagResourceRequest tagResourceRequest)
Add one or more tags (keys and values) to a specified resource. A tag is a label that you optionally define and associate with a resource. Tags can help you categorize and manage resources in different ways, such as by purpose, owner, environment, or other criteria. A resource can have as many as 50 tags.
Each tag consists of a required tag key and an associated tag value, both of which you define. A tag key is a general label that acts as a category for more specific tag values. A tag value acts as a descriptor within a tag key.
tagResourceRequest - BadRequestException - The input you provided is invalid.ConcurrentModificationException - The resource is being modified by another operation or thread.NotFoundException - The resource you attempted to access doesn't exist.TooManyRequestsException - Too many requests have been made to the operation.TestRenderEmailTemplateResult testRenderEmailTemplate(TestRenderEmailTemplateRequest testRenderEmailTemplateRequest)
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.
testRenderEmailTemplateRequest - >Represents a request to create a preview of the MIME content of an email when provided with a template
and a set of replacement data.NotFoundException - The resource you attempted to access doesn't exist.TooManyRequestsException - Too many requests have been made to the operation.BadRequestException - The input you provided is invalid.UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)
Remove one or more tags (keys and values) from a specified resource.
untagResourceRequest - BadRequestException - The input you provided is invalid.ConcurrentModificationException - The resource is being modified by another operation or thread.NotFoundException - The resource you attempted to access doesn't exist.TooManyRequestsException - Too many requests have been made to the operation.UpdateConfigurationSetEventDestinationResult updateConfigurationSetEventDestination(UpdateConfigurationSetEventDestinationRequest updateConfigurationSetEventDestinationRequest)
Update the configuration of an event destination for a configuration set.
Events include message sends, deliveries, opens, clicks, bounces, and complaints. Event destinations are places that you can send information about these events to. For example, you can send event data to Amazon EventBridge and associate a rule to send the event to the specified target.
updateConfigurationSetEventDestinationRequest - A request to change the settings for an event destination for a configuration set.NotFoundException - The resource you attempted to access doesn't exist.TooManyRequestsException - Too many requests have been made to the operation.BadRequestException - The input you provided is invalid.UpdateContactResult updateContact(UpdateContactRequest updateContactRequest)
Updates a contact's preferences for a list.
You must specify all existing topic preferences in the TopicPreferences object, not just the ones
that need updating; otherwise, all your existing preferences will be removed.
updateContactRequest - BadRequestException - The input you provided is invalid.TooManyRequestsException - Too many requests have been made to the operation.NotFoundException - The resource you attempted to access doesn't exist.ConcurrentModificationException - The resource is being modified by another operation or thread.UpdateContactListResult updateContactList(UpdateContactListRequest updateContactListRequest)
Updates contact list metadata. This operation does a complete replacement.
updateContactListRequest - BadRequestException - The input you provided is invalid.TooManyRequestsException - Too many requests have been made to the operation.NotFoundException - The resource you attempted to access doesn't exist.ConcurrentModificationException - The resource is being modified by another operation or thread.UpdateCustomVerificationEmailTemplateResult updateCustomVerificationEmailTemplate(UpdateCustomVerificationEmailTemplateRequest updateCustomVerificationEmailTemplateRequest)
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.
updateCustomVerificationEmailTemplateRequest - Represents a request to update an existing custom verification email template.NotFoundException - The resource you attempted to access doesn't exist.BadRequestException - The input you provided is invalid.TooManyRequestsException - Too many requests have been made to the operation.UpdateEmailIdentityPolicyResult updateEmailIdentityPolicy(UpdateEmailIdentityPolicyRequest updateEmailIdentityPolicyRequest)
Updates 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.
You can execute this operation no more than once per second.
updateEmailIdentityPolicyRequest - Represents a request to 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.NotFoundException - The resource you attempted to access doesn't exist.TooManyRequestsException - Too many requests have been made to the operation.BadRequestException - The input you provided is invalid.UpdateEmailTemplateResult updateEmailTemplate(UpdateEmailTemplateRequest updateEmailTemplateRequest)
Updates an email template. Email templates enable you to send personalized email to one or more destinations in a single API operation. For more information, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
updateEmailTemplateRequest - Represents a request to update an email template. For more information, see the Amazon SES
Developer Guide.NotFoundException - The resource you attempted to access doesn't exist.TooManyRequestsException - Too many requests have been made to the operation.BadRequestException - The input you provided is invalid.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.