aws-elixir

View Source AWS.SESv2 (aws-elixir v1.0.4)

Amazon SES API v2

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.

Link to this section Summary

Functions

batch_get_metric_data(client, input, options \\ [])

Retrieves batches of metric data collected based on your sending activity.

cancel_export_job(client, job_id, input, options \\ [])

Cancels an export job.

create_configuration_set(client, input, options \\ [])

Create a configuration set.

create_configuration_set_event_destination(client, configuration_set_name, input, options \\ [])

Create an event destination.

create_contact(client, contact_list_name, input, options \\ [])

Creates a contact, which is an end-user who is receiving the email, and adds them to a contact list.

create_contact_list(client, input, options \\ [])

Creates a contact list.

create_custom_verification_email_template(client, input, options \\ [])

Creates a new custom verification email template.

create_dedicated_ip_pool(client, input, options \\ [])

Create a new pool of dedicated IP addresses.

create_deliverability_test_report(client, input, options \\ [])

Create a new predictive inbox placement test.

create_email_identity(client, input, options \\ [])

Starts the process of verifying an email identity.

create_email_identity_policy(client, email_identity, policy_name, input, options \\ [])

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

create_email_template(client, input, options \\ [])

Creates an email template.

create_export_job(client, input, options \\ [])

Creates an export job for a data source and destination.

create_import_job(client, input, options \\ [])

Creates an import job for a data destination.

delete_configuration_set(client, configuration_set_name, input, options \\ [])

Delete an existing configuration set.

delete_configuration_set_event_destination(client, configuration_set_name, event_destination_name, input, options \\ [])

Delete an event destination.

delete_contact(client, contact_list_name, email_address, input, options \\ [])

Removes a contact from a contact list.

delete_contact_list(client, contact_list_name, input, options \\ [])

Deletes a contact list and all of the contacts on that list.

delete_custom_verification_email_template(client, template_name, input, options \\ [])

Deletes an existing custom verification email template.

delete_dedicated_ip_pool(client, pool_name, input, options \\ [])

Delete a dedicated IP pool.

delete_email_identity(client, email_identity, input, options \\ [])

Deletes an email identity.

delete_email_identity_policy(client, email_identity, policy_name, input, options \\ [])

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

delete_email_template(client, template_name, input, options \\ [])

Deletes an email template.

delete_suppressed_destination(client, email_address, input, options \\ [])

Removes an email address from the suppression list for your account.

get_account(client, options \\ [])

Obtain information about the email-sending status and capabilities of your Amazon SES account in the current Amazon Web Services Region.

get_blacklist_reports(client, blacklist_item_names, options \\ [])

Retrieve a list of the blacklists that your dedicated IP addresses appear on.

get_configuration_set(client, configuration_set_name, options \\ [])

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.

get_configuration_set_event_destinations(client, configuration_set_name, options \\ [])

Retrieve a list of event destinations that are associated with a configuration set.

get_contact(client, contact_list_name, email_address, options \\ [])

Returns a contact from a contact list.

get_contact_list(client, contact_list_name, options \\ [])

Returns contact list metadata.

get_custom_verification_email_template(client, template_name, options \\ [])

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

get_dedicated_ip(client, ip, options \\ [])

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.

get_dedicated_ip_pool(client, pool_name, options \\ [])

Retrieve information about the dedicated pool.

get_dedicated_ips(client, next_token \\ nil, page_size \\ nil, pool_name \\ nil, options \\ [])

List the dedicated IP addresses that are associated with your Amazon Web Services account.

get_deliverability_dashboard_options(client, options \\ [])

Retrieve information about the status of the Deliverability dashboard for your account.

get_deliverability_test_report(client, report_id, options \\ [])

Retrieve the results of a predictive inbox placement test.

get_domain_deliverability_campaign(client, campaign_id, options \\ [])

Retrieve all the deliverability data for a specific campaign.

get_domain_statistics_report(client, domain, end_date, start_date, options \\ [])

Retrieve inbox placement and engagement rates for the domains that you use to send email.

get_email_identity(client, email_identity, options \\ [])

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.

get_email_identity_policies(client, email_identity, options \\ [])

Returns the requested sending authorization policies for the given identity (an email address or a domain).

get_email_template(client, template_name, options \\ [])

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

get_export_job(client, job_id, options \\ [])

Provides information about an export job.

get_import_job(client, job_id, options \\ [])

Provides information about an import job.

get_message_insights(client, message_id, options \\ [])

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.

get_suppressed_destination(client, email_address, options \\ [])

Retrieves information about a specific email address that's on the suppression list for your account.

list_configuration_sets(client, next_token \\ nil, page_size \\ nil, options \\ [])

List all of the configuration sets associated with your account in the current region.

list_contact_lists(client, next_token \\ nil, page_size \\ nil, options \\ [])

Lists all of the contact lists available.

list_contacts(client, contact_list_name, input, options \\ [])

Lists the contacts present in a specific contact list.

list_custom_verification_email_templates(client, next_token \\ nil, page_size \\ nil, options \\ [])

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

list_dedicated_ip_pools(client, next_token \\ nil, page_size \\ nil, options \\ [])

List all of the dedicated IP pools that exist in your Amazon Web Services account in the current Region.

list_deliverability_test_reports(client, next_token \\ nil, page_size \\ nil, options \\ [])

Show a list of the predictive inbox placement tests that you've performed, regardless of their statuses.

list_domain_deliverability_campaigns(client, subscribed_domain, end_date, next_token \\ nil, page_size \\ nil, start_date, options \\ [])

Retrieve deliverability data for all the campaigns that used a specific domain to send email during a specified time range.

list_email_identities(client, next_token \\ nil, page_size \\ nil, options \\ [])

Returns a list of all of the email identities that are associated with your Amazon Web Services account.

list_email_templates(client, next_token \\ nil, page_size \\ nil, options \\ [])

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

list_export_jobs(client, input, options \\ [])

Lists all of the export jobs.

list_import_jobs(client, input, options \\ [])

Lists all of the import jobs.

list_recommendations(client, input, options \\ [])

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

list_suppressed_destinations(client, end_date \\ nil, next_token \\ nil, page_size \\ nil, reasons \\ nil, start_date \\ nil, options \\ [])

Retrieves a list of email addresses that are on the suppression list for your account.

list_tags_for_resource(client, resource_arn, options \\ [])

Retrieve a list of the tags (keys and values) that are associated with a specified resource.

metadata()
put_account_dedicated_ip_warmup_attributes(client, input, options \\ [])

Enable or disable the automatic warm-up feature for dedicated IP addresses.

put_account_details(client, input, options \\ [])

Update your Amazon SES account details.

put_account_sending_attributes(client, input, options \\ [])

Enable or disable the ability of your account to send email.

put_account_suppression_attributes(client, input, options \\ [])

Change the settings for the account-level suppression list.

put_account_vdm_attributes(client, input, options \\ [])

Update your Amazon SES account VDM attributes.

put_configuration_set_delivery_options(client, configuration_set_name, input, options \\ [])

Associate a configuration set with a dedicated IP pool.

put_configuration_set_reputation_options(client, configuration_set_name, input, options \\ [])

Enable or disable collection of reputation metrics for emails that you send using a particular configuration set in a specific Amazon Web Services Region.

put_configuration_set_sending_options(client, configuration_set_name, input, options \\ [])

Enable or disable email sending for messages that use a particular configuration set in a specific Amazon Web Services Region.

put_configuration_set_suppression_options(client, configuration_set_name, input, options \\ [])

Specify the account suppression list preferences for a configuration set.

put_configuration_set_tracking_options(client, configuration_set_name, input, options \\ [])

Specify a custom domain to use for open and click tracking elements in email that you send.

put_configuration_set_vdm_options(client, configuration_set_name, input, options \\ [])

Specify VDM preferences for email that you send using the configuration set.

put_dedicated_ip_in_pool(client, ip, input, options \\ [])

Move a dedicated IP address to an existing dedicated IP pool.

put_dedicated_ip_pool_scaling_attributes(client, pool_name, input, options \\ [])

Used to convert a dedicated IP pool to a different scaling mode.

put_dedicated_ip_warmup_attributes(client, ip, input, options \\ [])
put_deliverability_dashboard_option(client, input, options \\ [])

Enable or disable the Deliverability dashboard.

put_email_identity_configuration_set_attributes(client, email_identity, input, options \\ [])

Used to associate a configuration set with an email identity.

put_email_identity_dkim_attributes(client, email_identity, input, options \\ [])

Used to enable or disable DKIM authentication for an email identity.

put_email_identity_dkim_signing_attributes(client, email_identity, input, options \\ [])

Used to configure or change the DKIM authentication settings for an email domain identity.

put_email_identity_feedback_attributes(client, email_identity, input, options \\ [])

Used to enable or disable feedback forwarding for an identity.

put_email_identity_mail_from_attributes(client, email_identity, input, options \\ [])

Used to enable or disable the custom Mail-From domain configuration for an email identity.

put_suppressed_destination(client, input, options \\ [])

Adds an email address to the suppression list for your account.

send_bulk_email(client, input, options \\ [])

Composes an email message to multiple destinations.

send_custom_verification_email(client, input, options \\ [])

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.

send_email(client, input, options \\ [])

Sends an email message.

tag_resource(client, input, options \\ [])

Add one or more tags (keys and values) to a specified resource.

test_render_email_template(client, template_name, input, options \\ [])

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

untag_resource(client, input, options \\ [])

Remove one or more tags (keys and values) from a specified resource.

update_configuration_set_event_destination(client, configuration_set_name, event_destination_name, input, options \\ [])

Update the configuration of an event destination for a configuration set.

update_contact(client, contact_list_name, email_address, input, options \\ [])

Updates a contact's preferences for a list.

update_contact_list(client, contact_list_name, input, options \\ [])

Updates contact list metadata.

update_custom_verification_email_template(client, template_name, input, options \\ [])

Updates an existing custom verification email template.

update_email_identity_policy(client, email_identity, policy_name, input, options \\ [])

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

update_email_template(client, template_name, input, options \\ [])

Updates an email template.

Link to this section Functions

Link to this function

batch_get_metric_data(client, input, options \\ [])

View Source

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

Link to this function

cancel_export_job(client, job_id, input, options \\ [])

View Source

Cancels an export job.

Link to this function

create_configuration_set(client, input, options \\ [])

View Source

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.

Link to this function

create_configuration_set_event_destination(client, configuration_set_name, input, options \\ [])

View Source

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.

Link to this function

create_contact(client, contact_list_name, input, options \\ [])

View Source

Creates a contact, which is an end-user who is receiving the email, and adds them to a contact list.

Link to this function

create_contact_list(client, input, options \\ [])

View Source

Creates a contact list.

Link to this function

create_custom_verification_email_template(client, input, options \\ [])

View Source

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.

Link to this function

create_dedicated_ip_pool(client, input, options \\ [])

View Source

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.

Link to this function

create_deliverability_test_report(client, input, options \\ [])

View Source

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.

Link to this function

create_email_identity(client, input, options \\ [])

View Source

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.

Link to this function

create_email_identity_policy(client, email_identity, policy_name, input, options \\ [])

View Source

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.

Link to this function

create_email_template(client, input, options \\ [])

View Source

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.

Link to this function

create_export_job(client, input, options \\ [])

View Source

Creates an export job for a data source and destination.

You can execute this operation no more than once per second.

Link to this function

create_import_job(client, input, options \\ [])

View Source

Creates an import job for a data destination.

Link to this function

delete_configuration_set(client, configuration_set_name, input, options \\ [])

View Source

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.

Link to this function

delete_configuration_set_event_destination(client, configuration_set_name, event_destination_name, input, options \\ [])

View Source

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.

Link to this function

delete_contact(client, contact_list_name, email_address, input, options \\ [])

View Source

Removes a contact from a contact list.

Link to this function

delete_contact_list(client, contact_list_name, input, options \\ [])

View Source

Deletes a contact list and all of the contacts on that list.

Link to this function

delete_custom_verification_email_template(client, template_name, input, options \\ [])

View Source

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.

Link to this function

delete_dedicated_ip_pool(client, pool_name, input, options \\ [])

View Source

Delete a dedicated IP pool.

Link to this function

delete_email_identity(client, email_identity, input, options \\ [])

View Source

Deletes an email identity.

An identity can be either an email address or a domain name.

Link to this function

delete_email_identity_policy(client, email_identity, policy_name, input, options \\ [])

View Source

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.

Link to this function

delete_email_template(client, template_name, input, options \\ [])

View Source

Deletes an email template.

You can execute this operation no more than once per second.

Link to this function

delete_suppressed_destination(client, email_address, input, options \\ [])

View Source

Removes an email address from the suppression list for your account.

Link to this function

get_account(client, options \\ [])

View Source

Obtain information about the email-sending status and capabilities of your Amazon SES account in the current Amazon Web Services Region.

Link to this function

get_blacklist_reports(client, blacklist_item_names, options \\ [])

View Source

Retrieve a list of the blacklists that your dedicated IP addresses appear on.

Link to this function

get_configuration_set(client, configuration_set_name, options \\ [])

View Source

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.

Link to this function

get_configuration_set_event_destinations(client, configuration_set_name, options \\ [])

View Source

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.

Link to this function

get_contact(client, contact_list_name, email_address, options \\ [])

View Source

Returns a contact from a contact list.

Link to this function

get_contact_list(client, contact_list_name, options \\ [])

View Source

Returns contact list metadata.

It does not return any information about the contacts present in the list.

Link to this function

get_custom_verification_email_template(client, template_name, options \\ [])

View Source

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.

Link to this function

get_dedicated_ip(client, ip, options \\ [])

View Source

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.

Link to this function

get_dedicated_ip_pool(client, pool_name, options \\ [])

View Source

Retrieve information about the dedicated pool.

Link to this function

get_dedicated_ips(client, next_token \\ nil, page_size \\ nil, pool_name \\ nil, options \\ [])

View Source

List the dedicated IP addresses that are associated with your Amazon Web Services account.

Link to this function

get_deliverability_dashboard_options(client, options \\ [])

View Source

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.

Link to this function

get_deliverability_test_report(client, report_id, options \\ [])

View Source

Retrieve the results of a predictive inbox placement test.

Link to this function

get_domain_deliverability_campaign(client, campaign_id, options \\ [])

View Source

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.

Link to this function

get_domain_statistics_report(client, domain, end_date, start_date, options \\ [])

View Source

Retrieve inbox placement and engagement rates for the domains that you use to send email.

Link to this function

get_email_identity(client, email_identity, options \\ [])

View Source

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.

Link to this function

get_email_identity_policies(client, email_identity, options \\ [])

View Source

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.

Link to this function

get_email_template(client, template_name, options \\ [])

View Source

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.

Link to this function

get_export_job(client, job_id, options \\ [])

View Source

Provides information about an export job.

Link to this function

get_import_job(client, job_id, options \\ [])

View Source

Provides information about an import job.

Link to this function

get_message_insights(client, message_id, options \\ [])

View Source

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.

Link to this function

get_suppressed_destination(client, email_address, options \\ [])

View Source

Retrieves information about a specific email address that's on the suppression list for your account.

Link to this function

list_configuration_sets(client, next_token \\ nil, page_size \\ nil, options \\ [])

View Source

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.

Link to this function

list_contact_lists(client, next_token \\ nil, page_size \\ nil, options \\ [])

View Source

Lists all of the contact lists available.

Link to this function

list_contacts(client, contact_list_name, input, options \\ [])

View Source

Lists the contacts present in a specific contact list.

Link to this function

list_custom_verification_email_templates(client, next_token \\ nil, page_size \\ nil, options \\ [])

View Source

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.

Link to this function

list_dedicated_ip_pools(client, next_token \\ nil, page_size \\ nil, options \\ [])

View Source

List all of the dedicated IP pools that exist in your Amazon Web Services account in the current Region.

Link to this function

list_deliverability_test_reports(client, next_token \\ nil, page_size \\ nil, options \\ [])

View Source

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.

Link to this function

list_domain_deliverability_campaigns(client, subscribed_domain, end_date, next_token \\ nil, page_size \\ nil, start_date, options \\ [])

View Source

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.

Link to this function

list_email_identities(client, next_token \\ nil, page_size \\ nil, options \\ [])

View Source

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.

Link to this function

list_email_templates(client, next_token \\ nil, page_size \\ nil, options \\ [])

View Source

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.

Link to this function

list_export_jobs(client, input, options \\ [])

View Source

Lists all of the export jobs.

Link to this function

list_import_jobs(client, input, options \\ [])

View Source

Lists all of the import jobs.

Link to this function

list_recommendations(client, input, options \\ [])

View Source

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.

Link to this function

list_suppressed_destinations(client, end_date \\ nil, next_token \\ nil, page_size \\ nil, reasons \\ nil, start_date \\ nil, options \\ [])

View Source

Retrieves a list of email addresses that are on the suppression list for your account.

Link to this function

list_tags_for_resource(client, resource_arn, options \\ [])

View Source

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.

Link to this function

metadata()

View Source
Link to this function

put_account_dedicated_ip_warmup_attributes(client, input, options \\ [])

View Source

Enable or disable the automatic warm-up feature for dedicated IP addresses.

Link to this function

put_account_details(client, input, options \\ [])

View Source

Update your Amazon SES account details.

Link to this function

put_account_sending_attributes(client, input, options \\ [])

View Source

Enable or disable the ability of your account to send email.

Link to this function

put_account_suppression_attributes(client, input, options \\ [])

View Source

Change the settings for the account-level suppression list.

Link to this function

put_account_vdm_attributes(client, input, options \\ [])

View Source

Update your Amazon SES account VDM attributes.

You can execute this operation no more than once per second.

Link to this function

put_configuration_set_delivery_options(client, configuration_set_name, input, options \\ [])

View Source

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.

Link to this function

put_configuration_set_reputation_options(client, configuration_set_name, input, options \\ [])

View Source

Enable or disable collection of reputation metrics for emails that you send using a particular configuration set in a specific Amazon Web Services Region.

Link to this function

put_configuration_set_sending_options(client, configuration_set_name, input, options \\ [])

View Source

Enable or disable email sending for messages that use a particular configuration set in a specific Amazon Web Services Region.

Link to this function

put_configuration_set_suppression_options(client, configuration_set_name, input, options \\ [])

View Source

Specify the account suppression list preferences for a configuration set.

Link to this function

put_configuration_set_tracking_options(client, configuration_set_name, input, options \\ [])

View Source

Specify a custom domain to use for open and click tracking elements in email that you send.

Link to this function

put_configuration_set_vdm_options(client, configuration_set_name, input, options \\ [])

View Source

Specify VDM preferences for email that you send using the configuration set.

You can execute this operation no more than once per second.

Link to this function

put_dedicated_ip_in_pool(client, ip, input, options \\ [])

View Source

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.

Link to this function

put_dedicated_ip_pool_scaling_attributes(client, pool_name, input, options \\ [])

View Source

Used to convert a dedicated IP pool to a different scaling mode.

MANAGED pools cannot be converted to STANDARD scaling mode.

Link to this function

put_dedicated_ip_warmup_attributes(client, ip, input, options \\ [])

View Source
Link to this function

put_deliverability_dashboard_option(client, input, options \\ [])

View Source

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.

Link to this function

put_email_identity_configuration_set_attributes(client, email_identity, input, options \\ [])

View Source

Used to associate a configuration set with an email identity.

Link to this function

put_email_identity_dkim_attributes(client, email_identity, input, options \\ [])

View Source

Used to enable or disable DKIM authentication for an email identity.

Link to this function

put_email_identity_dkim_signing_attributes(client, email_identity, input, options \\ [])

View Source

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.

Link to this function

put_email_identity_feedback_attributes(client, email_identity, input, options \\ [])

View Source

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

Link to this function

put_email_identity_mail_from_attributes(client, email_identity, input, options \\ [])

View Source

Used to enable or disable the custom Mail-From domain configuration for an email identity.

Link to this function

put_suppressed_destination(client, input, options \\ [])

View Source

Adds an email address to the suppression list for your account.

Link to this function

send_bulk_email(client, input, options \\ [])

View Source

Composes an email message to multiple destinations.

Link to this function

send_custom_verification_email(client, input, options \\ [])

View Source

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.

Link to this function

send_email(client, input, options \\ [])

View Source

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.

Link to this function

tag_resource(client, input, options \\ [])

View Source

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.

Link to this function

test_render_email_template(client, template_name, input, options \\ [])

View Source

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.

Link to this function

untag_resource(client, input, options \\ [])

View Source

Remove one or more tags (keys and values) from a specified resource.

Link to this function

update_configuration_set_event_destination(client, configuration_set_name, event_destination_name, input, options \\ [])

View Source

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.

Link to this function

update_contact(client, contact_list_name, email_address, input, options \\ [])

View Source

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.

Link to this function

update_contact_list(client, contact_list_name, input, options \\ [])

View Source

Updates contact list metadata.

This operation does a complete replacement.

Link to this function

update_custom_verification_email_template(client, template_name, input, options \\ [])

View Source

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.

Link to this function

update_email_identity_policy(client, email_identity, policy_name, input, options \\ [])

View Source

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.

Link to this function

update_email_template(client, template_name, input, options \\ [])

View Source

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.