Sesv2

This page documents function available when using the Sesv2 module, created with @service Sesv2.

Index

Documentation

Main.Sesv2.batch_get_metric_dataMethod
batch_get_metric_data(queries)
batch_get_metric_data(queries, params::Dict{String,<:Any})

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

Arguments

  • queries: A list of queries for metrics to be retrieved.
Main.Sesv2.create_configuration_setMethod
create_configuration_set(configuration_set_name)
create_configuration_set(configuration_set_name, params::Dict{String,<:Any})

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.

Arguments

  • configuration_set_name: The name of the configuration set. The name can contain up to 64 alphanumeric characters, including letters, numbers, hyphens (-) and underscores (_) only.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "DeliveryOptions": An object that defines the dedicated IP pool that is used to send emails that you send using the configuration set.
  • "ReputationOptions": An object that defines whether or not Amazon SES collects reputation metrics for the emails that you send that use the configuration set.
  • "SendingOptions": An object that defines whether or not Amazon SES can send email that you send using the configuration set.
  • "SuppressionOptions":
  • "Tags": An array of objects that define the tags (keys and values) to associate with the configuration set.
  • "TrackingOptions": An object that defines the open and click tracking options for emails that you send using the configuration set.
  • "VdmOptions": An object that defines the VDM options for emails that you send using the configuration set.
Main.Sesv2.create_configuration_set_event_destinationMethod
create_configuration_set_event_destination(configuration_set_name, event_destination, event_destination_name)
create_configuration_set_event_destination(configuration_set_name, event_destination, event_destination_name, params::Dict{String,<:Any})

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 SNS to receive notifications when you receive bounces or complaints, or you can use Amazon Kinesis Data Firehose to stream data to Amazon S3 for long-term storage. A single configuration set can include more than one event destination.

Arguments

  • configuration_set_name: The name of the configuration set .
  • event_destination: An object that defines the event destination.
  • event_destination_name: A name that identifies the event destination within the configuration set.
Main.Sesv2.create_contactMethod
create_contact(contact_list_name, email_address)
create_contact(contact_list_name, email_address, params::Dict{String,<:Any})

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

Arguments

  • contact_list_name: The name of the contact list to which the contact should be added.
  • email_address: The contact's email address.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "AttributesData": The attribute data attached to a contact.
  • "TopicPreferences": The contact's preferences for being opted-in to or opted-out of topics.
  • "UnsubscribeAll": A boolean value status noting if the contact is unsubscribed from all contact list topics.
Main.Sesv2.create_contact_listMethod
create_contact_list(contact_list_name)
create_contact_list(contact_list_name, params::Dict{String,<:Any})

Creates a contact list.

Arguments

  • contact_list_name: The name of the contact list.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Description": A description of what the contact list is about.
  • "Tags": The tags associated with a contact list.
  • "Topics": An interest group, theme, or label within a list. A contact list can have multiple topics.
Main.Sesv2.create_custom_verification_email_templateMethod
create_custom_verification_email_template(failure_redirection_url, from_email_address, success_redirection_url, template_content, template_name, template_subject)
create_custom_verification_email_template(failure_redirection_url, from_email_address, success_redirection_url, template_content, template_name, template_subject, params::Dict{String,<:Any})

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.

Arguments

  • failure_redirection_url: The URL that the recipient of the verification email is sent to if his or her address is not successfully verified.
  • from_email_address: The email address that the custom verification email is sent from.
  • success_redirection_url: The URL that the recipient of the verification email is sent to if his or her address is successfully verified.
  • template_content: The content of the custom verification email. The total size of the email must be less than 10 MB. The message body may contain HTML, with some limitations. For more information, see Custom verification email frequently asked questions in the Amazon SES Developer Guide.
  • template_name: The name of the custom verification email template.
  • template_subject: The subject line of the custom verification email.
Main.Sesv2.create_dedicated_ip_poolMethod
create_dedicated_ip_pool(pool_name)
create_dedicated_ip_pool(pool_name, params::Dict{String,<:Any})

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.

Arguments

  • pool_name: The name of the dedicated IP pool.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "ScalingMode": The type of scaling mode.
  • "Tags": An object that defines the tags (keys and values) that you want to associate with the pool.
Main.Sesv2.create_deliverability_test_reportMethod
create_deliverability_test_report(content, from_email_address)
create_deliverability_test_report(content, from_email_address, params::Dict{String,<:Any})

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.

Arguments

  • content: The HTML body of the message that you sent when you performed the predictive inbox placement test.
  • from_email_address: The email address that the predictive inbox placement test email was sent from.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "ReportName": A unique name that helps you to identify the predictive inbox placement test when you retrieve the results.
  • "Tags": An array of objects that define the tags (keys and values) that you want to associate with the predictive inbox placement test.
Main.Sesv2.create_email_identityMethod
create_email_identity(email_identity)
create_email_identity(email_identity, params::Dict{String,<:Any})

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.

Arguments

  • email_identity: The email address or domain to verify.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "ConfigurationSetName": The configuration set to use by default when sending from this identity. Note that any configuration set defined in the email sending request takes precedence.
  • "DkimSigningAttributes": If your request includes this object, Amazon SES configures the identity to use Bring Your Own DKIM (BYODKIM) for DKIM authentication purposes, or, configures the key length to be used for Easy DKIM. You can only specify this object if the email identity is a domain, as opposed to an address.
  • "Tags": An array of objects that define the tags (keys and values) to associate with the email identity.
Main.Sesv2.create_email_identity_policyMethod
create_email_identity_policy(email_identity, policy, policy_name)
create_email_identity_policy(email_identity, policy, policy_name, params::Dict{String,<:Any})

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.

Arguments

  • email_identity: The email identity.
  • policy: The text of the policy in JSON format. The policy cannot exceed 4 KB. For information about the syntax of sending authorization policies, see the Amazon SES Developer Guide.
  • policy_name: The name of the policy. The policy name cannot exceed 64 characters and can only include alphanumeric characters, dashes, and underscores.
Main.Sesv2.create_email_templateMethod
create_email_template(template_content, template_name)
create_email_template(template_content, template_name, params::Dict{String,<:Any})

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.

Arguments

  • template_content: The content of the email template, composed of a subject line, an HTML part, and a text-only part.
  • template_name: The name of the template.
Main.Sesv2.create_import_jobMethod
create_import_job(import_data_source, import_destination)
create_import_job(import_data_source, import_destination, params::Dict{String,<:Any})

Creates an import job for a data destination.

Arguments

  • import_data_source: The data source for the import job.
  • import_destination: The destination for the import job.
Main.Sesv2.delete_configuration_setMethod
delete_configuration_set(configuration_set_name)
delete_configuration_set(configuration_set_name, params::Dict{String,<:Any})

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.

Arguments

  • configuration_set_name: The name of the configuration set.
Main.Sesv2.delete_configuration_set_event_destinationMethod
delete_configuration_set_event_destination(configuration_set_name, event_destination_name)
delete_configuration_set_event_destination(configuration_set_name, event_destination_name, params::Dict{String,<:Any})

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 SNS to receive notifications when you receive bounces or complaints, or you can use Amazon Kinesis Data Firehose to stream data to Amazon S3 for long-term storage.

Arguments

  • configuration_set_name: The name of the configuration set that contains the event destination to delete.
  • event_destination_name: The name of the event destination to delete.
Main.Sesv2.delete_contactMethod
delete_contact(contact_list_name, email_address)
delete_contact(contact_list_name, email_address, params::Dict{String,<:Any})

Removes a contact from a contact list.

Arguments

  • contact_list_name: The name of the contact list from which the contact should be removed.
  • email_address: The contact's email address.
Main.Sesv2.delete_contact_listMethod
delete_contact_list(contact_list_name)
delete_contact_list(contact_list_name, params::Dict{String,<:Any})

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

Arguments

  • contact_list_name: The name of the contact list.
Main.Sesv2.delete_custom_verification_email_templateMethod
delete_custom_verification_email_template(template_name)
delete_custom_verification_email_template(template_name, params::Dict{String,<:Any})

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.

Arguments

  • template_name: The name of the custom verification email template that you want to delete.
Main.Sesv2.delete_dedicated_ip_poolMethod
delete_dedicated_ip_pool(pool_name)
delete_dedicated_ip_pool(pool_name, params::Dict{String,<:Any})

Delete a dedicated IP pool.

Arguments

  • pool_name: The name of the dedicated IP pool that you want to delete.
Main.Sesv2.delete_email_identityMethod
delete_email_identity(email_identity)
delete_email_identity(email_identity, params::Dict{String,<:Any})

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

Arguments

  • email_identity: The identity (that is, the email address or domain) to delete.
Main.Sesv2.delete_email_identity_policyMethod
delete_email_identity_policy(email_identity, policy_name)
delete_email_identity_policy(email_identity, policy_name, params::Dict{String,<:Any})

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.

Arguments

  • email_identity: The email identity.
  • policy_name: The name of the policy. The policy name cannot exceed 64 characters and can only include alphanumeric characters, dashes, and underscores.
Main.Sesv2.delete_email_templateMethod
delete_email_template(template_name)
delete_email_template(template_name, params::Dict{String,<:Any})

Deletes an email template. You can execute this operation no more than once per second.

Arguments

  • template_name: The name of the template to be deleted.
Main.Sesv2.delete_suppressed_destinationMethod
delete_suppressed_destination(email_address)
delete_suppressed_destination(email_address, params::Dict{String,<:Any})

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

Arguments

  • email_address: The suppressed email destination to remove from the account suppression list.
Main.Sesv2.get_accountMethod
get_account()
get_account(params::Dict{String,<:Any})

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

Main.Sesv2.get_blacklist_reportsMethod
get_blacklist_reports(blacklist_item_names)
get_blacklist_reports(blacklist_item_names, params::Dict{String,<:Any})

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

Arguments

  • blacklist_item_names: A list of IP addresses that you want to retrieve blacklist information about. You can only specify the dedicated IP addresses that you use to send email using Amazon SES or Amazon Pinpoint.
Main.Sesv2.get_configuration_setMethod
get_configuration_set(configuration_set_name)
get_configuration_set(configuration_set_name, params::Dict{String,<:Any})

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.

Arguments

  • configuration_set_name: The name of the configuration set.
Main.Sesv2.get_configuration_set_event_destinationsMethod
get_configuration_set_event_destinations(configuration_set_name)
get_configuration_set_event_destinations(configuration_set_name, params::Dict{String,<:Any})

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 SNS to receive notifications when you receive bounces or complaints, or you can use Amazon Kinesis Data Firehose to stream data to Amazon S3 for long-term storage.

Arguments

  • configuration_set_name: The name of the configuration set that contains the event destination.
Main.Sesv2.get_contactMethod
get_contact(contact_list_name, email_address)
get_contact(contact_list_name, email_address, params::Dict{String,<:Any})

Returns a contact from a contact list.

Arguments

  • contact_list_name: The name of the contact list to which the contact belongs.
  • email_address: The contact's email address.
Main.Sesv2.get_contact_listMethod
get_contact_list(contact_list_name)
get_contact_list(contact_list_name, params::Dict{String,<:Any})

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

Arguments

  • contact_list_name: The name of the contact list.
Main.Sesv2.get_custom_verification_email_templateMethod
get_custom_verification_email_template(template_name)
get_custom_verification_email_template(template_name, params::Dict{String,<:Any})

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.

Arguments

  • template_name: The name of the custom verification email template that you want to retrieve.
Main.Sesv2.get_dedicated_ipMethod
get_dedicated_ip(ip)
get_dedicated_ip(ip, params::Dict{String,<:Any})

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.

Arguments

  • ip: The IP address that you want to obtain more information about. The value you specify has to be a dedicated IP address that's assocaited with your Amazon Web Services account.
Main.Sesv2.get_dedicated_ip_poolMethod
get_dedicated_ip_pool(pool_name)
get_dedicated_ip_pool(pool_name, params::Dict{String,<:Any})

Retrieve information about the dedicated pool.

Arguments

  • pool_name: The name of the dedicated IP pool to retrieve.
Main.Sesv2.get_dedicated_ipsMethod
get_dedicated_ips()
get_dedicated_ips(params::Dict{String,<:Any})

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

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "NextToken": A token returned from a previous call to GetDedicatedIps to indicate the position of the dedicated IP pool in the list of IP pools.
  • "PageSize": The number of results to show in a single call to GetDedicatedIpsRequest. If the number of results is larger than the number you specified in this parameter, then the response includes a NextToken element, which you can use to obtain additional results.
  • "PoolName": The name of the IP pool that the dedicated IP address is associated with.
Main.Sesv2.get_deliverability_dashboard_optionsMethod
get_deliverability_dashboard_options()
get_deliverability_dashboard_options(params::Dict{String,<:Any})

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.

Main.Sesv2.get_deliverability_test_reportMethod
get_deliverability_test_report(report_id)
get_deliverability_test_report(report_id, params::Dict{String,<:Any})

Retrieve the results of a predictive inbox placement test.

Arguments

  • report_id: A unique string that identifies the predictive inbox placement test.
Main.Sesv2.get_domain_deliverability_campaignMethod
get_domain_deliverability_campaign(campaign_id)
get_domain_deliverability_campaign(campaign_id, params::Dict{String,<:Any})

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.

Arguments

  • campaign_id: The unique identifier for the campaign. The Deliverability dashboard automatically generates and assigns this identifier to a campaign.
Main.Sesv2.get_domain_statistics_reportMethod
get_domain_statistics_report(domain, end_date, start_date)
get_domain_statistics_report(domain, end_date, start_date, params::Dict{String,<:Any})

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

Arguments

  • domain: The domain that you want to obtain deliverability metrics for.
  • end_date: The last day (in Unix time) that you want to obtain domain deliverability metrics for. The EndDate that you specify has to be less than or equal to 30 days after the StartDate.
  • start_date: The first day (in Unix time) that you want to obtain domain deliverability metrics for.
Main.Sesv2.get_email_identityMethod
get_email_identity(email_identity)
get_email_identity(email_identity, params::Dict{String,<:Any})

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.

Arguments

  • email_identity: The email identity.
Main.Sesv2.get_email_identity_policiesMethod
get_email_identity_policies(email_identity)
get_email_identity_policies(email_identity, params::Dict{String,<:Any})

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.

Arguments

  • email_identity: The email identity.
Main.Sesv2.get_email_templateMethod
get_email_template(template_name)
get_email_template(template_name, params::Dict{String,<:Any})

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.

Arguments

  • template_name: The name of the template.
Main.Sesv2.get_import_jobMethod
get_import_job(job_id)
get_import_job(job_id, params::Dict{String,<:Any})

Provides information about an import job.

Arguments

  • job_id: The ID of the import job.
Main.Sesv2.get_suppressed_destinationMethod
get_suppressed_destination(email_address)
get_suppressed_destination(email_address, params::Dict{String,<:Any})

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

Arguments

  • email_address: The email address that's on the account suppression list.
Main.Sesv2.list_configuration_setsMethod
list_configuration_sets()
list_configuration_sets(params::Dict{String,<:Any})

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.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "NextToken": A token returned from a previous call to ListConfigurationSets to indicate the position in the list of configuration sets.
  • "PageSize": The number of results to show in a single call to ListConfigurationSets. If the number of results is larger than the number you specified in this parameter, then the response includes a NextToken element, which you can use to obtain additional results.
Main.Sesv2.list_contact_listsMethod
list_contact_lists()
list_contact_lists(params::Dict{String,<:Any})

Lists all of the contact lists available.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "NextToken": A string token indicating that there might be additional contact lists available to be listed. Use the token provided in the Response to use in the subsequent call to ListContactLists with the same parameters to retrieve the next page of contact lists.
  • "PageSize": Maximum number of contact lists to return at once. Use this parameter to paginate results. If additional contact lists exist beyond the specified limit, the NextToken element is sent in the response. Use the NextToken value in subsequent requests to retrieve additional lists.
Main.Sesv2.list_contactsMethod
list_contacts(contact_list_name)
list_contacts(contact_list_name, params::Dict{String,<:Any})

Lists the contacts present in a specific contact list.

Arguments

  • contact_list_name: The name of the contact list.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Filter": A filter that can be applied to a list of contacts.
  • "NextToken": A string token indicating that there might be additional contacts available to be listed. Use the token provided in the Response to use in the subsequent call to ListContacts with the same parameters to retrieve the next page of contacts.
  • "PageSize": The number of contacts that may be returned at once, which is dependent on if there are more or less contacts than the value of the PageSize. Use this parameter to paginate results. If additional contacts exist beyond the specified limit, the NextToken element is sent in the response. Use the NextToken value in subsequent requests to retrieve additional contacts.
Main.Sesv2.list_custom_verification_email_templatesMethod
list_custom_verification_email_templates()
list_custom_verification_email_templates(params::Dict{String,<:Any})

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.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "NextToken": A token returned from a previous call to ListCustomVerificationEmailTemplates to indicate the position in the list of custom verification email templates.
  • "PageSize": The number of results to show in a single call to ListCustomVerificationEmailTemplates. If the number of results is larger than the number you specified in this parameter, then the response includes a NextToken element, which you can use to obtain additional results. The value you specify has to be at least 1, and can be no more than 50.
Main.Sesv2.list_dedicated_ip_poolsMethod
list_dedicated_ip_pools()
list_dedicated_ip_pools(params::Dict{String,<:Any})

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

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "NextToken": A token returned from a previous call to ListDedicatedIpPools to indicate the position in the list of dedicated IP pools.
  • "PageSize": The number of results to show in a single call to ListDedicatedIpPools. If the number of results is larger than the number you specified in this parameter, then the response includes a NextToken element, which you can use to obtain additional results.
Main.Sesv2.list_deliverability_test_reportsMethod
list_deliverability_test_reports()
list_deliverability_test_reports(params::Dict{String,<:Any})

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.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "NextToken": A token returned from a previous call to ListDeliverabilityTestReports to indicate the position in the list of predictive inbox placement tests.
  • "PageSize": The number of results to show in a single call to ListDeliverabilityTestReports. If the number of results is larger than the number you specified in this parameter, then the response includes a NextToken element, which you can use to obtain additional results. The value you specify has to be at least 0, and can be no more than 1000.
Main.Sesv2.list_domain_deliverability_campaignsMethod
list_domain_deliverability_campaigns(end_date, start_date, subscribed_domain)
list_domain_deliverability_campaigns(end_date, start_date, subscribed_domain, params::Dict{String,<:Any})

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.

Arguments

  • end_date: The last day that you want to obtain deliverability data for. This value has to be less than or equal to 30 days after the value of the StartDate parameter.
  • start_date: The first day that you want to obtain deliverability data for.
  • subscribed_domain: The domain to obtain deliverability data for.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "NextToken": A token that’s returned from a previous call to the ListDomainDeliverabilityCampaigns operation. This token indicates the position of a campaign in the list of campaigns.
  • "PageSize": The maximum number of results to include in response to a single call to the ListDomainDeliverabilityCampaigns operation. If the number of results is larger than the number that you specify in this parameter, the response includes a NextToken element, which you can use to obtain additional results.
Main.Sesv2.list_email_identitiesMethod
list_email_identities()
list_email_identities(params::Dict{String,<:Any})

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.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "NextToken": A token returned from a previous call to ListEmailIdentities to indicate the position in the list of identities.
  • "PageSize": The number of results to show in a single call to ListEmailIdentities. If the number of results is larger than the number you specified in this parameter, then the response includes a NextToken element, which you can use to obtain additional results. The value you specify has to be at least 0, and can be no more than 1000.
Main.Sesv2.list_email_templatesMethod
list_email_templates()
list_email_templates(params::Dict{String,<:Any})

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.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "NextToken": A token returned from a previous call to ListEmailTemplates to indicate the position in the list of email templates.
  • "PageSize": The number of results to show in a single call to ListEmailTemplates. If the number of results is larger than the number you specified in this parameter, then the response includes a NextToken element, which you can use to obtain additional results. The value you specify has to be at least 1, and can be no more than 10.
Main.Sesv2.list_import_jobsMethod
list_import_jobs()
list_import_jobs(params::Dict{String,<:Any})

Lists all of the import jobs.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "ImportDestinationType": The destination of the import job, which can be used to list import jobs that have a certain ImportDestinationType.
  • "NextToken": A string token indicating that there might be additional import jobs available to be listed. Copy this token to a subsequent call to ListImportJobs with the same parameters to retrieve the next page of import jobs.
  • "PageSize": Maximum number of import jobs to return at once. Use this parameter to paginate results. If additional import jobs exist beyond the specified limit, the NextToken element is sent in the response. Use the NextToken value in subsequent requests to retrieve additional addresses.
Main.Sesv2.list_recommendationsMethod
list_recommendations()
list_recommendations(params::Dict{String,<:Any})

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.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Filter": Filters applied when retrieving recommendations. Can eiter be an individual filter, or combinations of STATUS and IMPACT or STATUS and TYPE
  • "NextToken": A token returned from a previous call to ListRecommendations to indicate the position in the list of recommendations.
  • "PageSize": The number of results to show in a single call to ListRecommendations. If the number of results is larger than the number you specified in this parameter, then the response includes a NextToken element, which you can use to obtain additional results. The value you specify has to be at least 1, and can be no more than 100.
Main.Sesv2.list_suppressed_destinationsMethod
list_suppressed_destinations()
list_suppressed_destinations(params::Dict{String,<:Any})

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

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "EndDate": Used to filter the list of suppressed email destinations so that it only includes addresses that were added to the list before a specific date.
  • "NextToken": A token returned from a previous call to ListSuppressedDestinations to indicate the position in the list of suppressed email addresses.
  • "PageSize": The number of results to show in a single call to ListSuppressedDestinations. If the number of results is larger than the number you specified in this parameter, then the response includes a NextToken element, which you can use to obtain additional results.
  • "Reason": The factors that caused the email address to be added to .
  • "StartDate": Used to filter the list of suppressed email destinations so that it only includes addresses that were added to the list after a specific date.
Main.Sesv2.list_tags_for_resourceMethod
list_tags_for_resource(resource_arn)
list_tags_for_resource(resource_arn, params::Dict{String,<:Any})

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.

Arguments

  • resource_arn: The Amazon Resource Name (ARN) of the resource that you want to retrieve tag information for.
Main.Sesv2.put_account_dedicated_ip_warmup_attributesMethod
put_account_dedicated_ip_warmup_attributes()
put_account_dedicated_ip_warmup_attributes(params::Dict{String,<:Any})

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

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "AutoWarmupEnabled": Enables or disables the automatic warm-up feature for dedicated IP addresses that are associated with your Amazon SES account in the current Amazon Web Services Region. Set to true to enable the automatic warm-up feature, or set to false to disable it.
Main.Sesv2.put_account_detailsMethod
put_account_details(mail_type, use_case_description, website_url)
put_account_details(mail_type, use_case_description, website_url, params::Dict{String,<:Any})

Update your Amazon SES account details.

Arguments

  • mail_type: The type of email your account will send.
  • use_case_description: A description of the types of email that you plan to send.
  • website_url: The URL of your website. This information helps us better understand the type of content that you plan to send.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "AdditionalContactEmailAddresses": Additional email addresses that you would like to be notified regarding Amazon SES matters.
  • "ContactLanguage": The language you would prefer to be contacted with.
  • "ProductionAccessEnabled": Indicates whether or not your account should have production access in the current Amazon Web Services Region. If the value is false, then your account is in the sandbox. When your account is in the sandbox, you can only send email to verified identities. Additionally, the maximum number of emails you can send in a 24-hour period (your sending quota) is 200, and the maximum number of emails you can send per second (your maximum sending rate) is 1. If the value is true, then your account has production access. When your account has production access, you can send email to any address. The sending quota and maximum sending rate for your account vary based on your specific use case.
Main.Sesv2.put_account_sending_attributesMethod
put_account_sending_attributes()
put_account_sending_attributes(params::Dict{String,<:Any})

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

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "SendingEnabled": Enables or disables your account's ability to send email. Set to true to enable email sending, or set to false to disable email sending. If Amazon Web Services paused your account's ability to send email, you can't use this operation to resume your account's ability to send email.
Main.Sesv2.put_account_suppression_attributesMethod
put_account_suppression_attributes()
put_account_suppression_attributes(params::Dict{String,<:Any})

Change the settings for the account-level suppression list.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "SuppressedReasons": A list that contains the reasons that email addresses will be automatically added to the suppression list for your account. This list can contain any or all of the following: COMPLAINT – Amazon SES adds an email address to the suppression list for your account when a message sent to that address results in a complaint. BOUNCE – Amazon SES adds an email address to the suppression list for your account when a message sent to that address results in a hard bounce.
Main.Sesv2.put_account_vdm_attributesMethod
put_account_vdm_attributes(vdm_attributes)
put_account_vdm_attributes(vdm_attributes, params::Dict{String,<:Any})

Update your Amazon SES account VDM attributes. You can execute this operation no more than once per second.

Arguments

  • vdm_attributes: The VDM attributes that you wish to apply to your Amazon SES account.
Main.Sesv2.put_configuration_set_delivery_optionsMethod
put_configuration_set_delivery_options(configuration_set_name)
put_configuration_set_delivery_options(configuration_set_name, params::Dict{String,<:Any})

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.

Arguments

  • configuration_set_name: The name of the configuration set to associate with a dedicated IP pool.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "SendingPoolName": The name of the dedicated IP pool to associate with the configuration set.
  • "TlsPolicy": Specifies whether messages that use the configuration set are required to use Transport Layer Security (TLS). If the value is Require, messages are only delivered if a TLS connection can be established. If the value is Optional, messages can be delivered in plain text if a TLS connection can't be established.
Main.Sesv2.put_configuration_set_reputation_optionsMethod
put_configuration_set_reputation_options(configuration_set_name)
put_configuration_set_reputation_options(configuration_set_name, params::Dict{String,<:Any})

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

Arguments

  • configuration_set_name: The name of the configuration set.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "ReputationMetricsEnabled": If true, tracking of reputation metrics is enabled for the configuration set. If false, tracking of reputation metrics is disabled for the configuration set.
Main.Sesv2.put_configuration_set_sending_optionsMethod
put_configuration_set_sending_options(configuration_set_name)
put_configuration_set_sending_options(configuration_set_name, params::Dict{String,<:Any})

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

Arguments

  • configuration_set_name: The name of the configuration set to enable or disable email sending for.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "SendingEnabled": If true, email sending is enabled for the configuration set. If false, email sending is disabled for the configuration set.
Main.Sesv2.put_configuration_set_suppression_optionsMethod
put_configuration_set_suppression_options(configuration_set_name)
put_configuration_set_suppression_options(configuration_set_name, params::Dict{String,<:Any})

Specify the account suppression list preferences for a configuration set.

Arguments

  • configuration_set_name: The name of the configuration set to change the suppression list preferences for.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "SuppressedReasons": A list that contains the reasons that email addresses are automatically added to the suppression list for your account. This list can contain any or all of the following: COMPLAINT – Amazon SES adds an email address to the suppression list for your account when a message sent to that address results in a complaint. BOUNCE – Amazon SES adds an email address to the suppression list for your account when a message sent to that address results in a hard bounce.
Main.Sesv2.put_configuration_set_tracking_optionsMethod
put_configuration_set_tracking_options(configuration_set_name)
put_configuration_set_tracking_options(configuration_set_name, params::Dict{String,<:Any})

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

Arguments

  • configuration_set_name: The name of the configuration set.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "CustomRedirectDomain": The domain to use to track open and click events.
Main.Sesv2.put_configuration_set_vdm_optionsMethod
put_configuration_set_vdm_options(configuration_set_name)
put_configuration_set_vdm_options(configuration_set_name, params::Dict{String,<:Any})

Specify VDM preferences for email that you send using the configuration set. You can execute this operation no more than once per second.

Arguments

  • configuration_set_name: The name of the configuration set.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "VdmOptions": The VDM options to apply to the configuration set.
Main.Sesv2.put_dedicated_ip_in_poolMethod
put_dedicated_ip_in_pool(destination_pool_name, ip)
put_dedicated_ip_in_pool(destination_pool_name, ip, params::Dict{String,<:Any})

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.

Arguments

  • destination_pool_name: The name of the IP pool that you want to add the dedicated IP address to. You have to specify an IP pool that already exists.
  • ip: The IP address that you want to move to the dedicated IP pool. The value you specify has to be a dedicated IP address that's associated with your Amazon Web Services account.
Main.Sesv2.put_dedicated_ip_pool_scaling_attributesMethod
put_dedicated_ip_pool_scaling_attributes(pool_name, scaling_mode)
put_dedicated_ip_pool_scaling_attributes(pool_name, scaling_mode, params::Dict{String,<:Any})

Used to convert a dedicated IP pool to a different scaling mode. MANAGED pools cannot be converted to STANDARD scaling mode.

Arguments

  • pool_name: The name of the dedicated IP pool.
  • scaling_mode: The scaling mode to apply to the dedicated IP pool. Changing the scaling mode from MANAGED to STANDARD is not supported.
Main.Sesv2.put_dedicated_ip_warmup_attributesMethod
put_dedicated_ip_warmup_attributes(ip, warmup_percentage)
put_dedicated_ip_warmup_attributes(ip, warmup_percentage, params::Dict{String,<:Any})

Arguments

  • ip: The dedicated IP address that you want to update the warm-up attributes for.
  • warmup_percentage: The warm-up percentage that you want to associate with the dedicated IP address.
Main.Sesv2.put_deliverability_dashboard_optionMethod
put_deliverability_dashboard_option(dashboard_enabled)
put_deliverability_dashboard_option(dashboard_enabled, params::Dict{String,<:Any})

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.

Arguments

  • dashboard_enabled: Specifies whether to enable the Deliverability dashboard. To enable the dashboard, set this value to true.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "SubscribedDomains": An array of objects, one for each verified domain that you use to send email and enabled the Deliverability dashboard for.
Main.Sesv2.put_email_identity_configuration_set_attributesMethod
put_email_identity_configuration_set_attributes(email_identity)
put_email_identity_configuration_set_attributes(email_identity, params::Dict{String,<:Any})

Used to associate a configuration set with an email identity.

Arguments

  • email_identity: The email address or domain to associate with a configuration set.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "ConfigurationSetName": The configuration set to associate with an email identity.
Main.Sesv2.put_email_identity_dkim_attributesMethod
put_email_identity_dkim_attributes(email_identity)
put_email_identity_dkim_attributes(email_identity, params::Dict{String,<:Any})

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

Arguments

  • email_identity: The email identity.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "SigningEnabled": Sets the DKIM signing configuration for the identity. When you set this value true, then the messages that are sent from the identity are signed using DKIM. If you set this value to false, your messages are sent without DKIM signing.
Main.Sesv2.put_email_identity_dkim_signing_attributesMethod
put_email_identity_dkim_signing_attributes(email_identity, signing_attributes_origin)
put_email_identity_dkim_signing_attributes(email_identity, signing_attributes_origin, params::Dict{String,<:Any})

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.

Arguments

  • email_identity: The email identity.
  • signing_attributes_origin: The method to use to configure DKIM for the identity. There are the following possible values: AWS_SES – Configure DKIM for the identity by using Easy DKIM. EXTERNAL – Configure DKIM for the identity by using Bring Your Own DKIM (BYODKIM).

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "SigningAttributes": An object that contains information about the private key and selector that you want to use to configure DKIM for the identity for Bring Your Own DKIM (BYODKIM) for the identity, or, configures the key length to be used for Easy DKIM.
Main.Sesv2.put_email_identity_feedback_attributesMethod
put_email_identity_feedback_attributes(email_identity)
put_email_identity_feedback_attributes(email_identity, params::Dict{String,<:Any})

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

Arguments

  • email_identity: The email identity.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "EmailForwardingEnabled": Sets the feedback forwarding configuration for the identity. 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).
Main.Sesv2.put_email_identity_mail_from_attributesMethod
put_email_identity_mail_from_attributes(email_identity)
put_email_identity_mail_from_attributes(email_identity, params::Dict{String,<:Any})

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

Arguments

  • email_identity: The verified email identity.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "BehaviorOnMxFailure": The action to take if the required MX record isn't found when you send an email. When you set this value to UseDefaultValue, the mail is sent using amazonses.com as the MAIL FROM domain. When you set this value to RejectMessage, the Amazon SES API v2 returns a MailFromDomainNotVerified error, and doesn't attempt to deliver the email. These behaviors are taken when the custom MAIL FROM domain configuration is in the Pending, Failed, and TemporaryFailure states.
  • "MailFromDomain": The custom MAIL FROM domain that you want the verified identity to use. The MAIL FROM domain must meet the following criteria: It has to be a subdomain of the verified identity. It can't be used to receive email. It can't be used in a "From" address if the MAIL FROM domain is a destination for feedback forwarding emails.
Main.Sesv2.put_suppressed_destinationMethod
put_suppressed_destination(email_address, reason)
put_suppressed_destination(email_address, reason, params::Dict{String,<:Any})

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

Arguments

  • email_address: The email address that should be added to the suppression list for your account.
  • reason: The factors that should cause the email address to be added to the suppression list for your account.
Main.Sesv2.send_bulk_emailMethod
send_bulk_email(bulk_email_entries, default_content)
send_bulk_email(bulk_email_entries, default_content, params::Dict{String,<:Any})

Composes an email message to multiple destinations.

Arguments

  • bulk_email_entries: The list of bulk email entry objects.
  • default_content: An object that contains the body of the message. You can specify a template message.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "ConfigurationSetName": The name of the configuration set to use when sending the email.
  • "DefaultEmailTags": A list of tags, in the form of name/value pairs, to apply to an email that you send using the SendEmail operation. Tags correspond to characteristics of the email that you define, so that you can publish email sending events.
  • "FeedbackForwardingEmailAddress": The address that you want bounce and complaint notifications to be sent to.
  • "FeedbackForwardingEmailAddressIdentityArn": This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to use the email address specified in the FeedbackForwardingEmailAddress parameter. For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that authorizes you to use feedback@example.com, then you would specify the FeedbackForwardingEmailAddressIdentityArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the FeedbackForwardingEmailAddress to be feedback@example.com. For more information about sending authorization, see the Amazon SES Developer Guide.
  • "FromEmailAddress": The email address to use as the "From" address for the email. The address that you specify has to be verified.
  • "FromEmailAddressIdentityArn": This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to use the email address specified in the FromEmailAddress parameter. For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that authorizes you to use sender@example.com, then you would specify the FromEmailAddressIdentityArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the FromEmailAddress to be sender@example.com. For more information about sending authorization, see the Amazon SES Developer Guide.
  • "ReplyToAddresses": The "Reply-to" email addresses for the message. When the recipient replies to the message, each Reply-to address receives the reply.
Main.Sesv2.send_custom_verification_emailMethod
send_custom_verification_email(email_address, template_name)
send_custom_verification_email(email_address, template_name, params::Dict{String,<:Any})

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.

Arguments

  • email_address: The email address to verify.
  • template_name: The name of the custom verification email template to use when sending the verification email.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "ConfigurationSetName": Name of a configuration set to use when sending the verification email.
Main.Sesv2.send_emailMethod
send_email(content)
send_email(content, params::Dict{String,<:Any})

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.

Arguments

  • content: An object that contains the body of the message. You can send either a Simple message Raw message or a template Message.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "ConfigurationSetName": The name of the configuration set to use when sending the email.
  • "Destination": An object that contains the recipients of the email message.
  • "EmailTags": A list of tags, in the form of name/value pairs, to apply to an email that you send using the SendEmail operation. Tags correspond to characteristics of the email that you define, so that you can publish email sending events.
  • "FeedbackForwardingEmailAddress": The address that you want bounce and complaint notifications to be sent to.
  • "FeedbackForwardingEmailAddressIdentityArn": This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to use the email address specified in the FeedbackForwardingEmailAddress parameter. For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that authorizes you to use feedback@example.com, then you would specify the FeedbackForwardingEmailAddressIdentityArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the FeedbackForwardingEmailAddress to be feedback@example.com. For more information about sending authorization, see the Amazon SES Developer Guide.
  • "FromEmailAddress": The email address to use as the "From" address for the email. The address that you specify has to be verified.
  • "FromEmailAddressIdentityArn": This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to use the email address specified in the FromEmailAddress parameter. For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that authorizes you to use sender@example.com, then you would specify the FromEmailAddressIdentityArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the FromEmailAddress to be sender@example.com. For more information about sending authorization, see the Amazon SES Developer Guide. For Raw emails, the FromEmailAddressIdentityArn value overrides the X-SES-SOURCE-ARN and X-SES-FROM-ARN headers specified in raw email message content.
  • "ListManagementOptions": An object used to specify a list or topic to which an email belongs, which will be used when a contact chooses to unsubscribe.
  • "ReplyToAddresses": The "Reply-to" email addresses for the message. When the recipient replies to the message, each Reply-to address receives the reply.
Main.Sesv2.tag_resourceMethod
tag_resource(resource_arn, tags)
tag_resource(resource_arn, tags, params::Dict{String,<:Any})

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.

Arguments

  • resource_arn: The Amazon Resource Name (ARN) of the resource that you want to add one or more tags to.
  • tags: A list of the tags that you want to add to the resource. A tag consists of a required tag key (Key) and an associated tag value (Value). The maximum length of a tag key is 128 characters. The maximum length of a tag value is 256 characters.
Main.Sesv2.test_render_email_templateMethod
test_render_email_template(template_data, template_name)
test_render_email_template(template_data, template_name, params::Dict{String,<:Any})

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.

Arguments

  • template_data: A list of replacement values to apply to the template. This parameter is a JSON object, typically consisting of key-value pairs in which the keys correspond to replacement tags in the email template.
  • template_name: The name of the template.
Main.Sesv2.untag_resourceMethod
untag_resource(resource_arn, tag_keys)
untag_resource(resource_arn, tag_keys, params::Dict{String,<:Any})

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

Arguments

  • resource_arn: The Amazon Resource Name (ARN) of the resource that you want to remove one or more tags from.
  • tag_keys: The tags (tag keys) that you want to remove from the resource. When you specify a tag key, the action removes both that key and its associated tag value. To remove more than one tag from the resource, append the TagKeys parameter and argument for each additional tag to remove, separated by an ampersand. For example: /v2/email/tags?ResourceArn=ResourceArn&amp;TagKeys=Key1&amp;TagKeys=Key2
Main.Sesv2.update_configuration_set_event_destinationMethod
update_configuration_set_event_destination(configuration_set_name, event_destination, event_destination_name)
update_configuration_set_event_destination(configuration_set_name, event_destination, event_destination_name, params::Dict{String,<:Any})

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 SNS to receive notifications when you receive bounces or complaints, or you can use Amazon Kinesis Data Firehose to stream data to Amazon S3 for long-term storage.

Arguments

  • configuration_set_name: The name of the configuration set that contains the event destination to modify.
  • event_destination: An object that defines the event destination.
  • event_destination_name: The name of the event destination.
Main.Sesv2.update_contactMethod
update_contact(contact_list_name, email_address)
update_contact(contact_list_name, email_address, params::Dict{String,<:Any})

Updates a contact's preferences for a list. It is not necessary to specify all existing topic preferences in the TopicPreferences object, just the ones that need updating.

Arguments

  • contact_list_name: The name of the contact list.
  • email_address: The contact's email address.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "AttributesData": The attribute data attached to a contact.
  • "TopicPreferences": The contact's preference for being opted-in to or opted-out of a topic.
  • "UnsubscribeAll": A boolean value status noting if the contact is unsubscribed from all contact list topics.
Main.Sesv2.update_contact_listMethod
update_contact_list(contact_list_name)
update_contact_list(contact_list_name, params::Dict{String,<:Any})

Updates contact list metadata. This operation does a complete replacement.

Arguments

  • contact_list_name: The name of the contact list.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Description": A description of what the contact list is about.
  • "Topics": An interest group, theme, or label within a list. A contact list can have multiple topics.
Main.Sesv2.update_custom_verification_email_templateMethod
update_custom_verification_email_template(failure_redirection_url, from_email_address, success_redirection_url, template_content, template_name, template_subject)
update_custom_verification_email_template(failure_redirection_url, from_email_address, success_redirection_url, template_content, template_name, template_subject, params::Dict{String,<:Any})

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.

Arguments

  • failure_redirection_url: The URL that the recipient of the verification email is sent to if his or her address is not successfully verified.
  • from_email_address: The email address that the custom verification email is sent from.
  • success_redirection_url: The URL that the recipient of the verification email is sent to if his or her address is successfully verified.
  • template_content: The content of the custom verification email. The total size of the email must be less than 10 MB. The message body may contain HTML, with some limitations. For more information, see Custom verification email frequently asked questions in the Amazon SES Developer Guide.
  • template_name: The name of the custom verification email template that you want to update.
  • template_subject: The subject line of the custom verification email.
Main.Sesv2.update_email_identity_policyMethod
update_email_identity_policy(email_identity, policy, policy_name)
update_email_identity_policy(email_identity, policy, policy_name, params::Dict{String,<:Any})

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.

Arguments

  • email_identity: The email identity.
  • policy: The text of the policy in JSON format. The policy cannot exceed 4 KB. For information about the syntax of sending authorization policies, see the Amazon SES Developer Guide.
  • policy_name: The name of the policy. The policy name cannot exceed 64 characters and can only include alphanumeric characters, dashes, and underscores.
Main.Sesv2.update_email_templateMethod
update_email_template(template_content, template_name)
update_email_template(template_content, template_name, params::Dict{String,<:Any})

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.

Arguments

  • template_content: The content of the email template, composed of a subject line, an HTML part, and a text-only part.
  • template_name: The name of the template.