@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AbstractAmazonSimpleEmailServiceV2 extends Object implements AmazonSimpleEmailServiceV2
AmazonSimpleEmailServiceV2
. Convenient method forms pass through to the
corresponding overload that takes a request object, which throws an UnsupportedOperationException
.ENDPOINT_PREFIX
Modifier and Type | Method and Description |
---|---|
BatchGetMetricDataResult |
batchGetMetricData(BatchGetMetricDataRequest request)
Retrieves batches of metric data collected based on your sending activity.
|
CancelExportJobResult |
cancelExportJob(CancelExportJobRequest request)
Cancels an export job.
|
CreateConfigurationSetResult |
createConfigurationSet(CreateConfigurationSetRequest request)
Create a configuration set.
|
CreateConfigurationSetEventDestinationResult |
createConfigurationSetEventDestination(CreateConfigurationSetEventDestinationRequest request)
Create an event destination.
|
CreateContactResult |
createContact(CreateContactRequest request)
Creates a contact, which is an end-user who is receiving the email, and adds them to a contact list.
|
CreateContactListResult |
createContactList(CreateContactListRequest request)
Creates a contact list.
|
CreateCustomVerificationEmailTemplateResult |
createCustomVerificationEmailTemplate(CreateCustomVerificationEmailTemplateRequest request)
Creates a new custom verification email template.
|
CreateDedicatedIpPoolResult |
createDedicatedIpPool(CreateDedicatedIpPoolRequest request)
Create a new pool of dedicated IP addresses.
|
CreateDeliverabilityTestReportResult |
createDeliverabilityTestReport(CreateDeliverabilityTestReportRequest request)
Create a new predictive inbox placement test.
|
CreateEmailIdentityResult |
createEmailIdentity(CreateEmailIdentityRequest request)
Starts the process of verifying an email identity.
|
CreateEmailIdentityPolicyResult |
createEmailIdentityPolicy(CreateEmailIdentityPolicyRequest request)
Creates the specified sending authorization policy for the given identity (an email address or a domain).
|
CreateEmailTemplateResult |
createEmailTemplate(CreateEmailTemplateRequest request)
Creates an email template.
|
CreateExportJobResult |
createExportJob(CreateExportJobRequest request)
Creates an export job for a data source and destination.
|
CreateImportJobResult |
createImportJob(CreateImportJobRequest request)
Creates an import job for a data destination.
|
DeleteConfigurationSetResult |
deleteConfigurationSet(DeleteConfigurationSetRequest request)
Delete an existing configuration set.
|
DeleteConfigurationSetEventDestinationResult |
deleteConfigurationSetEventDestination(DeleteConfigurationSetEventDestinationRequest request)
Delete an event destination.
|
DeleteContactResult |
deleteContact(DeleteContactRequest request)
Removes a contact from a contact list.
|
DeleteContactListResult |
deleteContactList(DeleteContactListRequest request)
Deletes a contact list and all of the contacts on that list.
|
DeleteCustomVerificationEmailTemplateResult |
deleteCustomVerificationEmailTemplate(DeleteCustomVerificationEmailTemplateRequest request)
Deletes an existing custom verification email template.
|
DeleteDedicatedIpPoolResult |
deleteDedicatedIpPool(DeleteDedicatedIpPoolRequest request)
Delete a dedicated IP pool.
|
DeleteEmailIdentityResult |
deleteEmailIdentity(DeleteEmailIdentityRequest request)
Deletes an email identity.
|
DeleteEmailIdentityPolicyResult |
deleteEmailIdentityPolicy(DeleteEmailIdentityPolicyRequest request)
Deletes the specified sending authorization policy for the given identity (an email address or a domain).
|
DeleteEmailTemplateResult |
deleteEmailTemplate(DeleteEmailTemplateRequest request)
Deletes an email template.
|
DeleteSuppressedDestinationResult |
deleteSuppressedDestination(DeleteSuppressedDestinationRequest request)
Removes an email address from the suppression list for your account.
|
GetAccountResult |
getAccount(GetAccountRequest request)
Obtain information about the email-sending status and capabilities of your Amazon SES account in the current
Amazon Web Services Region.
|
GetBlacklistReportsResult |
getBlacklistReports(GetBlacklistReportsRequest request)
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 request)
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 request)
Retrieve a list of event destinations that are associated with a configuration set.
|
GetContactResult |
getContact(GetContactRequest request)
Returns a contact from a contact list.
|
GetContactListResult |
getContactList(GetContactListRequest request)
Returns contact list metadata.
|
GetCustomVerificationEmailTemplateResult |
getCustomVerificationEmailTemplate(GetCustomVerificationEmailTemplateRequest request)
Returns the custom email verification template for the template name you specify.
|
GetDedicatedIpResult |
getDedicatedIp(GetDedicatedIpRequest request)
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 request)
Retrieve information about the dedicated pool.
|
GetDedicatedIpsResult |
getDedicatedIps(GetDedicatedIpsRequest request)
List the dedicated IP addresses that are associated with your Amazon Web Services account.
|
GetDeliverabilityDashboardOptionsResult |
getDeliverabilityDashboardOptions(GetDeliverabilityDashboardOptionsRequest request)
Retrieve information about the status of the Deliverability dashboard for your account.
|
GetDeliverabilityTestReportResult |
getDeliverabilityTestReport(GetDeliverabilityTestReportRequest request)
Retrieve the results of a predictive inbox placement test.
|
GetDomainDeliverabilityCampaignResult |
getDomainDeliverabilityCampaign(GetDomainDeliverabilityCampaignRequest request)
Retrieve all the deliverability data for a specific campaign.
|
GetDomainStatisticsReportResult |
getDomainStatisticsReport(GetDomainStatisticsReportRequest request)
Retrieve inbox placement and engagement rates for the domains that you use to send email.
|
GetEmailIdentityResult |
getEmailIdentity(GetEmailIdentityRequest request)
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 request)
Returns the requested sending authorization policies for the given identity (an email address or a domain).
|
GetEmailTemplateResult |
getEmailTemplate(GetEmailTemplateRequest request)
Displays the template object (which includes the subject line, HTML part and text part) for the template you
specify.
|
GetExportJobResult |
getExportJob(GetExportJobRequest request)
Provides information about an export job.
|
GetImportJobResult |
getImportJob(GetImportJobRequest request)
Provides information about an import job.
|
GetMessageInsightsResult |
getMessageInsights(GetMessageInsightsRequest request)
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 request)
Retrieves information about a specific email address that's on the suppression list for your account.
|
ListConfigurationSetsResult |
listConfigurationSets(ListConfigurationSetsRequest request)
List all of the configuration sets associated with your account in the current region.
|
ListContactListsResult |
listContactLists(ListContactListsRequest request)
Lists all of the contact lists available.
|
ListContactsResult |
listContacts(ListContactsRequest request)
Lists the contacts present in a specific contact list.
|
ListCustomVerificationEmailTemplatesResult |
listCustomVerificationEmailTemplates(ListCustomVerificationEmailTemplatesRequest request)
Lists the existing custom verification email templates for your account in the current Amazon Web Services
Region.
|
ListDedicatedIpPoolsResult |
listDedicatedIpPools(ListDedicatedIpPoolsRequest request)
List all of the dedicated IP pools that exist in your Amazon Web Services account in the current Region.
|
ListDeliverabilityTestReportsResult |
listDeliverabilityTestReports(ListDeliverabilityTestReportsRequest request)
Show a list of the predictive inbox placement tests that you've performed, regardless of their statuses.
|
ListDomainDeliverabilityCampaignsResult |
listDomainDeliverabilityCampaigns(ListDomainDeliverabilityCampaignsRequest request)
Retrieve deliverability data for all the campaigns that used a specific domain to send email during a specified
time range.
|
ListEmailIdentitiesResult |
listEmailIdentities(ListEmailIdentitiesRequest request)
Returns a list of all of the email identities that are associated with your Amazon Web Services account.
|
ListEmailTemplatesResult |
listEmailTemplates(ListEmailTemplatesRequest request)
Lists the email templates present in your Amazon SES account in the current Amazon Web Services Region.
|
ListExportJobsResult |
listExportJobs(ListExportJobsRequest request)
Lists all of the export jobs.
|
ListImportJobsResult |
listImportJobs(ListImportJobsRequest request)
Lists all of the import jobs.
|
ListRecommendationsResult |
listRecommendations(ListRecommendationsRequest request)
Lists the recommendations present in your Amazon SES account in the current Amazon Web Services Region.
|
ListSuppressedDestinationsResult |
listSuppressedDestinations(ListSuppressedDestinationsRequest request)
Retrieves a list of email addresses that are on the suppression list for your account.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest request)
Retrieve a list of the tags (keys and values) that are associated with a specified resource.
|
PutAccountDedicatedIpWarmupAttributesResult |
putAccountDedicatedIpWarmupAttributes(PutAccountDedicatedIpWarmupAttributesRequest request)
Enable or disable the automatic warm-up feature for dedicated IP addresses.
|
PutAccountDetailsResult |
putAccountDetails(PutAccountDetailsRequest request)
Update your Amazon SES account details.
|
PutAccountSendingAttributesResult |
putAccountSendingAttributes(PutAccountSendingAttributesRequest request)
Enable or disable the ability of your account to send email.
|
PutAccountSuppressionAttributesResult |
putAccountSuppressionAttributes(PutAccountSuppressionAttributesRequest request)
Change the settings for the account-level suppression list.
|
PutAccountVdmAttributesResult |
putAccountVdmAttributes(PutAccountVdmAttributesRequest request)
Update your Amazon SES account VDM attributes.
|
PutConfigurationSetDeliveryOptionsResult |
putConfigurationSetDeliveryOptions(PutConfigurationSetDeliveryOptionsRequest request)
Associate a configuration set with a dedicated IP pool.
|
PutConfigurationSetReputationOptionsResult |
putConfigurationSetReputationOptions(PutConfigurationSetReputationOptionsRequest request)
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 request)
Enable or disable email sending for messages that use a particular configuration set in a specific Amazon Web
Services Region.
|
PutConfigurationSetSuppressionOptionsResult |
putConfigurationSetSuppressionOptions(PutConfigurationSetSuppressionOptionsRequest request)
Specify the account suppression list preferences for a configuration set.
|
PutConfigurationSetTrackingOptionsResult |
putConfigurationSetTrackingOptions(PutConfigurationSetTrackingOptionsRequest request)
Specify a custom domain to use for open and click tracking elements in email that you send.
|
PutConfigurationSetVdmOptionsResult |
putConfigurationSetVdmOptions(PutConfigurationSetVdmOptionsRequest request)
Specify VDM preferences for email that you send using the configuration set.
|
PutDedicatedIpInPoolResult |
putDedicatedIpInPool(PutDedicatedIpInPoolRequest request)
Move a dedicated IP address to an existing dedicated IP pool.
|
PutDedicatedIpPoolScalingAttributesResult |
putDedicatedIpPoolScalingAttributes(PutDedicatedIpPoolScalingAttributesRequest request)
Used to convert a dedicated IP pool to a different scaling mode.
|
PutDedicatedIpWarmupAttributesResult |
putDedicatedIpWarmupAttributes(PutDedicatedIpWarmupAttributesRequest request)
|
PutDeliverabilityDashboardOptionResult |
putDeliverabilityDashboardOption(PutDeliverabilityDashboardOptionRequest request)
Enable or disable the Deliverability dashboard.
|
PutEmailIdentityConfigurationSetAttributesResult |
putEmailIdentityConfigurationSetAttributes(PutEmailIdentityConfigurationSetAttributesRequest request)
Used to associate a configuration set with an email identity.
|
PutEmailIdentityDkimAttributesResult |
putEmailIdentityDkimAttributes(PutEmailIdentityDkimAttributesRequest request)
Used to enable or disable DKIM authentication for an email identity.
|
PutEmailIdentityDkimSigningAttributesResult |
putEmailIdentityDkimSigningAttributes(PutEmailIdentityDkimSigningAttributesRequest request)
Used to configure or change the DKIM authentication settings for an email domain identity.
|
PutEmailIdentityFeedbackAttributesResult |
putEmailIdentityFeedbackAttributes(PutEmailIdentityFeedbackAttributesRequest request)
Used to enable or disable feedback forwarding for an identity.
|
PutEmailIdentityMailFromAttributesResult |
putEmailIdentityMailFromAttributes(PutEmailIdentityMailFromAttributesRequest request)
Used to enable or disable the custom Mail-From domain configuration for an email identity.
|
PutSuppressedDestinationResult |
putSuppressedDestination(PutSuppressedDestinationRequest request)
Adds an email address to the suppression list for your account.
|
SendBulkEmailResult |
sendBulkEmail(SendBulkEmailRequest request)
Composes an email message to multiple destinations.
|
SendCustomVerificationEmailResult |
sendCustomVerificationEmail(SendCustomVerificationEmailRequest request)
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 request)
Sends an email message.
|
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
TagResourceResult |
tagResource(TagResourceRequest request)
Add one or more tags (keys and values) to a specified resource.
|
TestRenderEmailTemplateResult |
testRenderEmailTemplate(TestRenderEmailTemplateRequest request)
Creates a preview of the MIME content of an email when provided with a template and a set of replacement data.
|
UntagResourceResult |
untagResource(UntagResourceRequest request)
Remove one or more tags (keys and values) from a specified resource.
|
UpdateConfigurationSetEventDestinationResult |
updateConfigurationSetEventDestination(UpdateConfigurationSetEventDestinationRequest request)
Update the configuration of an event destination for a configuration set.
|
UpdateContactResult |
updateContact(UpdateContactRequest request)
Updates a contact's preferences for a list.
|
UpdateContactListResult |
updateContactList(UpdateContactListRequest request)
Updates contact list metadata.
|
UpdateCustomVerificationEmailTemplateResult |
updateCustomVerificationEmailTemplate(UpdateCustomVerificationEmailTemplateRequest request)
Updates an existing custom verification email template.
|
UpdateEmailIdentityPolicyResult |
updateEmailIdentityPolicy(UpdateEmailIdentityPolicyRequest request)
Updates the specified sending authorization policy for the given identity (an email address or a domain).
|
UpdateEmailTemplateResult |
updateEmailTemplate(UpdateEmailTemplateRequest request)
Updates an email template.
|
public BatchGetMetricDataResult batchGetMetricData(BatchGetMetricDataRequest request)
AmazonSimpleEmailServiceV2
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).
batchGetMetricData
in interface AmazonSimpleEmailServiceV2
request
- Represents a request to retrieve a batch of metric data.public CancelExportJobResult cancelExportJob(CancelExportJobRequest request)
AmazonSimpleEmailServiceV2
Cancels an export job.
cancelExportJob
in interface AmazonSimpleEmailServiceV2
request
- Represents a request to cancel an export job using the export job ID.public CreateConfigurationSetResult createConfigurationSet(CreateConfigurationSetRequest request)
AmazonSimpleEmailServiceV2
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.
createConfigurationSet
in interface AmazonSimpleEmailServiceV2
request
- A request to create a configuration set.public CreateConfigurationSetEventDestinationResult createConfigurationSetEventDestination(CreateConfigurationSetEventDestinationRequest request)
AmazonSimpleEmailServiceV2
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.
createConfigurationSetEventDestination
in interface AmazonSimpleEmailServiceV2
request
- A request to add an event destination to a configuration set.public CreateContactResult createContact(CreateContactRequest request)
AmazonSimpleEmailServiceV2
Creates a contact, which is an end-user who is receiving the email, and adds them to a contact list.
createContact
in interface AmazonSimpleEmailServiceV2
public CreateContactListResult createContactList(CreateContactListRequest request)
AmazonSimpleEmailServiceV2
Creates a contact list.
createContactList
in interface AmazonSimpleEmailServiceV2
public CreateCustomVerificationEmailTemplateResult createCustomVerificationEmailTemplate(CreateCustomVerificationEmailTemplateRequest request)
AmazonSimpleEmailServiceV2
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.
createCustomVerificationEmailTemplate
in interface AmazonSimpleEmailServiceV2
request
- Represents a request to create a custom verification email template.public CreateDedicatedIpPoolResult createDedicatedIpPool(CreateDedicatedIpPoolRequest request)
AmazonSimpleEmailServiceV2
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.
createDedicatedIpPool
in interface AmazonSimpleEmailServiceV2
request
- A request to create a new dedicated IP pool.public CreateDeliverabilityTestReportResult createDeliverabilityTestReport(CreateDeliverabilityTestReportRequest request)
AmazonSimpleEmailServiceV2
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.
createDeliverabilityTestReport
in interface AmazonSimpleEmailServiceV2
request
- 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.public CreateEmailIdentityResult createEmailIdentity(CreateEmailIdentityRequest request)
AmazonSimpleEmailServiceV2
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.
createEmailIdentity
in interface AmazonSimpleEmailServiceV2
request
- A request to begin the verification process for an email identity (an email address or domain).public CreateEmailIdentityPolicyResult createEmailIdentityPolicy(CreateEmailIdentityPolicyRequest request)
AmazonSimpleEmailServiceV2
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.
createEmailIdentityPolicy
in interface AmazonSimpleEmailServiceV2
request
- 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.public CreateEmailTemplateResult createEmailTemplate(CreateEmailTemplateRequest request)
AmazonSimpleEmailServiceV2
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.
createEmailTemplate
in interface AmazonSimpleEmailServiceV2
request
- Represents a request to create an email template. For more information, see the Amazon SES
Developer Guide.public CreateExportJobResult createExportJob(CreateExportJobRequest request)
AmazonSimpleEmailServiceV2
Creates an export job for a data source and destination.
You can execute this operation no more than once per second.
createExportJob
in interface AmazonSimpleEmailServiceV2
request
- Represents a request to create an export job from a data source to a data destination.public CreateImportJobResult createImportJob(CreateImportJobRequest request)
AmazonSimpleEmailServiceV2
Creates an import job for a data destination.
createImportJob
in interface AmazonSimpleEmailServiceV2
request
- Represents a request to create an import job from a data source for a data destination.public DeleteConfigurationSetResult deleteConfigurationSet(DeleteConfigurationSetRequest request)
AmazonSimpleEmailServiceV2
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.
deleteConfigurationSet
in interface AmazonSimpleEmailServiceV2
request
- A request to delete a configuration set.public DeleteConfigurationSetEventDestinationResult deleteConfigurationSetEventDestination(DeleteConfigurationSetEventDestinationRequest request)
AmazonSimpleEmailServiceV2
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.
deleteConfigurationSetEventDestination
in interface AmazonSimpleEmailServiceV2
request
- A request to delete an event destination from a configuration set.public DeleteContactResult deleteContact(DeleteContactRequest request)
AmazonSimpleEmailServiceV2
Removes a contact from a contact list.
deleteContact
in interface AmazonSimpleEmailServiceV2
public DeleteContactListResult deleteContactList(DeleteContactListRequest request)
AmazonSimpleEmailServiceV2
Deletes a contact list and all of the contacts on that list.
deleteContactList
in interface AmazonSimpleEmailServiceV2
public DeleteCustomVerificationEmailTemplateResult deleteCustomVerificationEmailTemplate(DeleteCustomVerificationEmailTemplateRequest request)
AmazonSimpleEmailServiceV2
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.
deleteCustomVerificationEmailTemplate
in interface AmazonSimpleEmailServiceV2
request
- Represents a request to delete an existing custom verification email template.public DeleteDedicatedIpPoolResult deleteDedicatedIpPool(DeleteDedicatedIpPoolRequest request)
AmazonSimpleEmailServiceV2
Delete a dedicated IP pool.
deleteDedicatedIpPool
in interface AmazonSimpleEmailServiceV2
request
- A request to delete a dedicated IP pool.public DeleteEmailIdentityResult deleteEmailIdentity(DeleteEmailIdentityRequest request)
AmazonSimpleEmailServiceV2
Deletes an email identity. An identity can be either an email address or a domain name.
deleteEmailIdentity
in interface AmazonSimpleEmailServiceV2
request
- 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.public DeleteEmailIdentityPolicyResult deleteEmailIdentityPolicy(DeleteEmailIdentityPolicyRequest request)
AmazonSimpleEmailServiceV2
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.
deleteEmailIdentityPolicy
in interface AmazonSimpleEmailServiceV2
request
- 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.public DeleteEmailTemplateResult deleteEmailTemplate(DeleteEmailTemplateRequest request)
AmazonSimpleEmailServiceV2
Deletes an email template.
You can execute this operation no more than once per second.
deleteEmailTemplate
in interface AmazonSimpleEmailServiceV2
request
- Represents a request to delete an email template. For more information, see the Amazon SES
Developer Guide.public DeleteSuppressedDestinationResult deleteSuppressedDestination(DeleteSuppressedDestinationRequest request)
AmazonSimpleEmailServiceV2
Removes an email address from the suppression list for your account.
deleteSuppressedDestination
in interface AmazonSimpleEmailServiceV2
request
- A request to remove an email address from the suppression list for your account.public GetAccountResult getAccount(GetAccountRequest request)
AmazonSimpleEmailServiceV2
Obtain information about the email-sending status and capabilities of your Amazon SES account in the current Amazon Web Services Region.
getAccount
in interface AmazonSimpleEmailServiceV2
request
- A request to obtain information about the email-sending capabilities of your Amazon SES account.public GetBlacklistReportsResult getBlacklistReports(GetBlacklistReportsRequest request)
AmazonSimpleEmailServiceV2
Retrieve a list of the blacklists that your dedicated IP addresses appear on.
getBlacklistReports
in interface AmazonSimpleEmailServiceV2
request
- A request to retrieve a list of the blacklists that your dedicated IP addresses appear on.public GetConfigurationSetResult getConfigurationSet(GetConfigurationSetRequest request)
AmazonSimpleEmailServiceV2
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.
getConfigurationSet
in interface AmazonSimpleEmailServiceV2
request
- A request to obtain information about a configuration set.public GetConfigurationSetEventDestinationsResult getConfigurationSetEventDestinations(GetConfigurationSetEventDestinationsRequest request)
AmazonSimpleEmailServiceV2
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.
getConfigurationSetEventDestinations
in interface AmazonSimpleEmailServiceV2
request
- A request to obtain information about the event destinations for a configuration set.public GetContactResult getContact(GetContactRequest request)
AmazonSimpleEmailServiceV2
Returns a contact from a contact list.
getContact
in interface AmazonSimpleEmailServiceV2
public GetContactListResult getContactList(GetContactListRequest request)
AmazonSimpleEmailServiceV2
Returns contact list metadata. It does not return any information about the contacts present in the list.
getContactList
in interface AmazonSimpleEmailServiceV2
public GetCustomVerificationEmailTemplateResult getCustomVerificationEmailTemplate(GetCustomVerificationEmailTemplateRequest request)
AmazonSimpleEmailServiceV2
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.
getCustomVerificationEmailTemplate
in interface AmazonSimpleEmailServiceV2
request
- Represents a request to retrieve an existing custom verification email template.public GetDedicatedIpResult getDedicatedIp(GetDedicatedIpRequest request)
AmazonSimpleEmailServiceV2
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.
getDedicatedIp
in interface AmazonSimpleEmailServiceV2
request
- A request to obtain more information about a dedicated IP address.public GetDedicatedIpPoolResult getDedicatedIpPool(GetDedicatedIpPoolRequest request)
AmazonSimpleEmailServiceV2
Retrieve information about the dedicated pool.
getDedicatedIpPool
in interface AmazonSimpleEmailServiceV2
request
- A request to obtain more information about a dedicated IP pool.public GetDedicatedIpsResult getDedicatedIps(GetDedicatedIpsRequest request)
AmazonSimpleEmailServiceV2
List the dedicated IP addresses that are associated with your Amazon Web Services account.
getDedicatedIps
in interface AmazonSimpleEmailServiceV2
request
- A request to obtain more information about dedicated IP pools.public GetDeliverabilityDashboardOptionsResult getDeliverabilityDashboardOptions(GetDeliverabilityDashboardOptionsRequest request)
AmazonSimpleEmailServiceV2
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.
getDeliverabilityDashboardOptions
in interface AmazonSimpleEmailServiceV2
request
- 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.
public GetDeliverabilityTestReportResult getDeliverabilityTestReport(GetDeliverabilityTestReportRequest request)
AmazonSimpleEmailServiceV2
Retrieve the results of a predictive inbox placement test.
getDeliverabilityTestReport
in interface AmazonSimpleEmailServiceV2
request
- A request to retrieve the results of a predictive inbox placement test.public GetDomainDeliverabilityCampaignResult getDomainDeliverabilityCampaign(GetDomainDeliverabilityCampaignRequest request)
AmazonSimpleEmailServiceV2
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.
getDomainDeliverabilityCampaign
in interface AmazonSimpleEmailServiceV2
request
- 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).public GetDomainStatisticsReportResult getDomainStatisticsReport(GetDomainStatisticsReportRequest request)
AmazonSimpleEmailServiceV2
Retrieve inbox placement and engagement rates for the domains that you use to send email.
getDomainStatisticsReport
in interface AmazonSimpleEmailServiceV2
request
- A request to obtain deliverability metrics for a domain.public GetEmailIdentityResult getEmailIdentity(GetEmailIdentityRequest request)
AmazonSimpleEmailServiceV2
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.
getEmailIdentity
in interface AmazonSimpleEmailServiceV2
request
- A request to return details about an email identity.public GetEmailIdentityPoliciesResult getEmailIdentityPolicies(GetEmailIdentityPoliciesRequest request)
AmazonSimpleEmailServiceV2
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.
getEmailIdentityPolicies
in interface AmazonSimpleEmailServiceV2
request
- A request to return the policies of an email identity.public GetEmailTemplateResult getEmailTemplate(GetEmailTemplateRequest request)
AmazonSimpleEmailServiceV2
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.
getEmailTemplate
in interface AmazonSimpleEmailServiceV2
request
- Represents a request to display the template object (which includes the subject line, HTML part and text
part) for the template you specify.public GetExportJobResult getExportJob(GetExportJobRequest request)
AmazonSimpleEmailServiceV2
Provides information about an export job.
getExportJob
in interface AmazonSimpleEmailServiceV2
request
- Represents a request to retrieve information about an export job using the export job ID.public GetImportJobResult getImportJob(GetImportJobRequest request)
AmazonSimpleEmailServiceV2
Provides information about an import job.
getImportJob
in interface AmazonSimpleEmailServiceV2
request
- Represents a request for information about an import job using the import job ID.public GetMessageInsightsResult getMessageInsights(GetMessageInsightsRequest request)
AmazonSimpleEmailServiceV2
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.
getMessageInsights
in interface AmazonSimpleEmailServiceV2
request
- A request to return information about a message.public GetSuppressedDestinationResult getSuppressedDestination(GetSuppressedDestinationRequest request)
AmazonSimpleEmailServiceV2
Retrieves information about a specific email address that's on the suppression list for your account.
getSuppressedDestination
in interface AmazonSimpleEmailServiceV2
request
- A request to retrieve information about an email address that's on the suppression list for your account.public ListConfigurationSetsResult listConfigurationSets(ListConfigurationSetsRequest request)
AmazonSimpleEmailServiceV2
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.
listConfigurationSets
in interface AmazonSimpleEmailServiceV2
request
- A request to obtain a list of configuration sets for your Amazon SES account in the current Amazon Web
Services Region.public ListContactListsResult listContactLists(ListContactListsRequest request)
AmazonSimpleEmailServiceV2
Lists all of the contact lists available.
listContactLists
in interface AmazonSimpleEmailServiceV2
public ListContactsResult listContacts(ListContactsRequest request)
AmazonSimpleEmailServiceV2
Lists the contacts present in a specific contact list.
listContacts
in interface AmazonSimpleEmailServiceV2
public ListCustomVerificationEmailTemplatesResult listCustomVerificationEmailTemplates(ListCustomVerificationEmailTemplatesRequest request)
AmazonSimpleEmailServiceV2
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.
listCustomVerificationEmailTemplates
in interface AmazonSimpleEmailServiceV2
request
- Represents a request to list the existing custom verification email templates for your account.public ListDedicatedIpPoolsResult listDedicatedIpPools(ListDedicatedIpPoolsRequest request)
AmazonSimpleEmailServiceV2
List all of the dedicated IP pools that exist in your Amazon Web Services account in the current Region.
listDedicatedIpPools
in interface AmazonSimpleEmailServiceV2
request
- A request to obtain a list of dedicated IP pools.public ListDeliverabilityTestReportsResult listDeliverabilityTestReports(ListDeliverabilityTestReportsRequest request)
AmazonSimpleEmailServiceV2
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.
listDeliverabilityTestReports
in interface AmazonSimpleEmailServiceV2
request
- A request to list all of the predictive inbox placement tests that you've performed.public ListDomainDeliverabilityCampaignsResult listDomainDeliverabilityCampaigns(ListDomainDeliverabilityCampaignsRequest request)
AmazonSimpleEmailServiceV2
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.
listDomainDeliverabilityCampaigns
in interface AmazonSimpleEmailServiceV2
request
- 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.public ListEmailIdentitiesResult listEmailIdentities(ListEmailIdentitiesRequest request)
AmazonSimpleEmailServiceV2
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.
listEmailIdentities
in interface AmazonSimpleEmailServiceV2
request
- 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.public ListEmailTemplatesResult listEmailTemplates(ListEmailTemplatesRequest request)
AmazonSimpleEmailServiceV2
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.
listEmailTemplates
in interface AmazonSimpleEmailServiceV2
request
- 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.public ListExportJobsResult listExportJobs(ListExportJobsRequest request)
AmazonSimpleEmailServiceV2
Lists all of the export jobs.
listExportJobs
in interface AmazonSimpleEmailServiceV2
request
- Represents a request to list all export jobs with filters.public ListImportJobsResult listImportJobs(ListImportJobsRequest request)
AmazonSimpleEmailServiceV2
Lists all of the import jobs.
listImportJobs
in interface AmazonSimpleEmailServiceV2
request
- Represents a request to list all of the import jobs for a data destination within the specified maximum
number of import jobs.public ListRecommendationsResult listRecommendations(ListRecommendationsRequest request)
AmazonSimpleEmailServiceV2
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.
listRecommendations
in interface AmazonSimpleEmailServiceV2
request
- Represents a request to list the existing recommendations for your account.public ListSuppressedDestinationsResult listSuppressedDestinations(ListSuppressedDestinationsRequest request)
AmazonSimpleEmailServiceV2
Retrieves a list of email addresses that are on the suppression list for your account.
listSuppressedDestinations
in interface AmazonSimpleEmailServiceV2
request
- A request to obtain a list of email destinations that are on the suppression list for your account.public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
AmazonSimpleEmailServiceV2
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.
listTagsForResource
in interface AmazonSimpleEmailServiceV2
public PutAccountDedicatedIpWarmupAttributesResult putAccountDedicatedIpWarmupAttributes(PutAccountDedicatedIpWarmupAttributesRequest request)
AmazonSimpleEmailServiceV2
Enable or disable the automatic warm-up feature for dedicated IP addresses.
putAccountDedicatedIpWarmupAttributes
in interface AmazonSimpleEmailServiceV2
request
- A request to enable or disable the automatic IP address warm-up feature.public PutAccountDetailsResult putAccountDetails(PutAccountDetailsRequest request)
AmazonSimpleEmailServiceV2
Update your Amazon SES account details.
putAccountDetails
in interface AmazonSimpleEmailServiceV2
request
- A request to submit new account details.public PutAccountSendingAttributesResult putAccountSendingAttributes(PutAccountSendingAttributesRequest request)
AmazonSimpleEmailServiceV2
Enable or disable the ability of your account to send email.
putAccountSendingAttributes
in interface AmazonSimpleEmailServiceV2
request
- A request to change the ability of your account to send email.public PutAccountSuppressionAttributesResult putAccountSuppressionAttributes(PutAccountSuppressionAttributesRequest request)
AmazonSimpleEmailServiceV2
Change the settings for the account-level suppression list.
putAccountSuppressionAttributes
in interface AmazonSimpleEmailServiceV2
request
- A request to change your account's suppression preferences.public PutAccountVdmAttributesResult putAccountVdmAttributes(PutAccountVdmAttributesRequest request)
AmazonSimpleEmailServiceV2
Update your Amazon SES account VDM attributes.
You can execute this operation no more than once per second.
putAccountVdmAttributes
in interface AmazonSimpleEmailServiceV2
request
- A request to submit new account VDM attributes.public PutConfigurationSetDeliveryOptionsResult putConfigurationSetDeliveryOptions(PutConfigurationSetDeliveryOptionsRequest request)
AmazonSimpleEmailServiceV2
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.
putConfigurationSetDeliveryOptions
in interface AmazonSimpleEmailServiceV2
request
- A request to associate a configuration set with a dedicated IP pool.public PutConfigurationSetReputationOptionsResult putConfigurationSetReputationOptions(PutConfigurationSetReputationOptionsRequest request)
AmazonSimpleEmailServiceV2
Enable or disable collection of reputation metrics for emails that you send using a particular configuration set in a specific Amazon Web Services Region.
putConfigurationSetReputationOptions
in interface AmazonSimpleEmailServiceV2
request
- A request to enable or disable tracking of reputation metrics for a configuration set.public PutConfigurationSetSendingOptionsResult putConfigurationSetSendingOptions(PutConfigurationSetSendingOptionsRequest request)
AmazonSimpleEmailServiceV2
Enable or disable email sending for messages that use a particular configuration set in a specific Amazon Web Services Region.
putConfigurationSetSendingOptions
in interface AmazonSimpleEmailServiceV2
request
- A request to enable or disable the ability of Amazon SES to send emails that use a specific configuration
set.public PutConfigurationSetSuppressionOptionsResult putConfigurationSetSuppressionOptions(PutConfigurationSetSuppressionOptionsRequest request)
AmazonSimpleEmailServiceV2
Specify the account suppression list preferences for a configuration set.
putConfigurationSetSuppressionOptions
in interface AmazonSimpleEmailServiceV2
request
- A request to change the account suppression list preferences for a specific configuration set.public PutConfigurationSetTrackingOptionsResult putConfigurationSetTrackingOptions(PutConfigurationSetTrackingOptionsRequest request)
AmazonSimpleEmailServiceV2
Specify a custom domain to use for open and click tracking elements in email that you send.
putConfigurationSetTrackingOptions
in interface AmazonSimpleEmailServiceV2
request
- A request to add a custom domain for tracking open and click events to a configuration set.public PutConfigurationSetVdmOptionsResult putConfigurationSetVdmOptions(PutConfigurationSetVdmOptionsRequest request)
AmazonSimpleEmailServiceV2
Specify VDM preferences for email that you send using the configuration set.
You can execute this operation no more than once per second.
putConfigurationSetVdmOptions
in interface AmazonSimpleEmailServiceV2
request
- A request to add specific VDM settings to a configuration set.public PutDedicatedIpInPoolResult putDedicatedIpInPool(PutDedicatedIpInPoolRequest request)
AmazonSimpleEmailServiceV2
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.
putDedicatedIpInPool
in interface AmazonSimpleEmailServiceV2
request
- A request to move a dedicated IP address to a dedicated IP pool.public PutDedicatedIpPoolScalingAttributesResult putDedicatedIpPoolScalingAttributes(PutDedicatedIpPoolScalingAttributesRequest request)
AmazonSimpleEmailServiceV2
Used to convert a dedicated IP pool to a different scaling mode.
MANAGED
pools cannot be converted to STANDARD
scaling mode.
putDedicatedIpPoolScalingAttributes
in interface AmazonSimpleEmailServiceV2
request
- A request to convert a dedicated IP pool to a different scaling mode.public PutDedicatedIpWarmupAttributesResult putDedicatedIpWarmupAttributes(PutDedicatedIpWarmupAttributesRequest request)
AmazonSimpleEmailServiceV2
putDedicatedIpWarmupAttributes
in interface AmazonSimpleEmailServiceV2
request
- 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.public PutDeliverabilityDashboardOptionResult putDeliverabilityDashboardOption(PutDeliverabilityDashboardOptionRequest request)
AmazonSimpleEmailServiceV2
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.
putDeliverabilityDashboardOption
in interface AmazonSimpleEmailServiceV2
request
- 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.
public PutEmailIdentityConfigurationSetAttributesResult putEmailIdentityConfigurationSetAttributes(PutEmailIdentityConfigurationSetAttributesRequest request)
AmazonSimpleEmailServiceV2
Used to associate a configuration set with an email identity.
putEmailIdentityConfigurationSetAttributes
in interface AmazonSimpleEmailServiceV2
request
- A request to associate a configuration set with an email identity.public PutEmailIdentityDkimAttributesResult putEmailIdentityDkimAttributes(PutEmailIdentityDkimAttributesRequest request)
AmazonSimpleEmailServiceV2
Used to enable or disable DKIM authentication for an email identity.
putEmailIdentityDkimAttributes
in interface AmazonSimpleEmailServiceV2
request
- A request to enable or disable DKIM signing of email that you send from an email identity.public PutEmailIdentityDkimSigningAttributesResult putEmailIdentityDkimSigningAttributes(PutEmailIdentityDkimSigningAttributesRequest request)
AmazonSimpleEmailServiceV2
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.
putEmailIdentityDkimSigningAttributes
in interface AmazonSimpleEmailServiceV2
request
- A request to change the DKIM attributes for an email identity.public PutEmailIdentityFeedbackAttributesResult putEmailIdentityFeedbackAttributes(PutEmailIdentityFeedbackAttributesRequest request)
AmazonSimpleEmailServiceV2
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).
putEmailIdentityFeedbackAttributes
in interface AmazonSimpleEmailServiceV2
request
- A request to set the attributes that control how bounce and complaint events are processed.public PutEmailIdentityMailFromAttributesResult putEmailIdentityMailFromAttributes(PutEmailIdentityMailFromAttributesRequest request)
AmazonSimpleEmailServiceV2
Used to enable or disable the custom Mail-From domain configuration for an email identity.
putEmailIdentityMailFromAttributes
in interface AmazonSimpleEmailServiceV2
request
- A request to configure the custom MAIL FROM domain for a verified identity.public PutSuppressedDestinationResult putSuppressedDestination(PutSuppressedDestinationRequest request)
AmazonSimpleEmailServiceV2
Adds an email address to the suppression list for your account.
putSuppressedDestination
in interface AmazonSimpleEmailServiceV2
request
- A request to add an email destination to the suppression list for your account.public SendBulkEmailResult sendBulkEmail(SendBulkEmailRequest request)
AmazonSimpleEmailServiceV2
Composes an email message to multiple destinations.
sendBulkEmail
in interface AmazonSimpleEmailServiceV2
request
- Represents a request to send email messages to multiple destinations using Amazon SES. For more
information, see the Amazon SES
Developer Guide.public SendCustomVerificationEmailResult sendCustomVerificationEmail(SendCustomVerificationEmailRequest request)
AmazonSimpleEmailServiceV2
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.
sendCustomVerificationEmail
in interface AmazonSimpleEmailServiceV2
request
- Represents a request to send a custom verification email to a specified recipient.public SendEmailResult sendEmail(SendEmailRequest request)
AmazonSimpleEmailServiceV2
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.
sendEmail
in interface AmazonSimpleEmailServiceV2
request
- Represents a request to send a single formatted email using Amazon SES. For more information, see the Amazon SES
Developer Guide.public TagResourceResult tagResource(TagResourceRequest request)
AmazonSimpleEmailServiceV2
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.
tagResource
in interface AmazonSimpleEmailServiceV2
public TestRenderEmailTemplateResult testRenderEmailTemplate(TestRenderEmailTemplateRequest request)
AmazonSimpleEmailServiceV2
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.
testRenderEmailTemplate
in interface AmazonSimpleEmailServiceV2
request
- >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.public UntagResourceResult untagResource(UntagResourceRequest request)
AmazonSimpleEmailServiceV2
Remove one or more tags (keys and values) from a specified resource.
untagResource
in interface AmazonSimpleEmailServiceV2
public UpdateConfigurationSetEventDestinationResult updateConfigurationSetEventDestination(UpdateConfigurationSetEventDestinationRequest request)
AmazonSimpleEmailServiceV2
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.
updateConfigurationSetEventDestination
in interface AmazonSimpleEmailServiceV2
request
- A request to change the settings for an event destination for a configuration set.public UpdateContactResult updateContact(UpdateContactRequest request)
AmazonSimpleEmailServiceV2
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.
updateContact
in interface AmazonSimpleEmailServiceV2
public UpdateContactListResult updateContactList(UpdateContactListRequest request)
AmazonSimpleEmailServiceV2
Updates contact list metadata. This operation does a complete replacement.
updateContactList
in interface AmazonSimpleEmailServiceV2
public UpdateCustomVerificationEmailTemplateResult updateCustomVerificationEmailTemplate(UpdateCustomVerificationEmailTemplateRequest request)
AmazonSimpleEmailServiceV2
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.
updateCustomVerificationEmailTemplate
in interface AmazonSimpleEmailServiceV2
request
- Represents a request to update an existing custom verification email template.public UpdateEmailIdentityPolicyResult updateEmailIdentityPolicy(UpdateEmailIdentityPolicyRequest request)
AmazonSimpleEmailServiceV2
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.
updateEmailIdentityPolicy
in interface AmazonSimpleEmailServiceV2
request
- 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.public UpdateEmailTemplateResult updateEmailTemplate(UpdateEmailTemplateRequest request)
AmazonSimpleEmailServiceV2
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.
updateEmailTemplate
in interface AmazonSimpleEmailServiceV2
request
- Represents a request to update an email template. For more information, see the Amazon SES
Developer Guide.public void shutdown()
AmazonSimpleEmailServiceV2
shutdown
in interface AmazonSimpleEmailServiceV2
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
AmazonSimpleEmailServiceV2
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.
getCachedResponseMetadata
in interface AmazonSimpleEmailServiceV2
request
- The originally executed request.