Class: Aws::SESV2::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::SESV2::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb
Overview
An API client for SESV2. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::SESV2::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#batch_get_metric_data(params = {}) ⇒ Types::BatchGetMetricDataResponse
Retrieves batches of metric data collected based on your sending activity.
-
#cancel_export_job(params = {}) ⇒ Struct
Cancels an export job.
-
#create_configuration_set(params = {}) ⇒ Struct
Create a configuration set.
-
#create_configuration_set_event_destination(params = {}) ⇒ Struct
Create an event destination.
-
#create_contact(params = {}) ⇒ Struct
Creates a contact, which is an end-user who is receiving the email, and adds them to a contact list.
-
#create_contact_list(params = {}) ⇒ Struct
Creates a contact list.
-
#create_custom_verification_email_template(params = {}) ⇒ Struct
Creates a new custom verification email template.
-
#create_dedicated_ip_pool(params = {}) ⇒ Struct
Create a new pool of dedicated IP addresses.
-
#create_deliverability_test_report(params = {}) ⇒ Types::CreateDeliverabilityTestReportResponse
Create a new predictive inbox placement test.
-
#create_email_identity(params = {}) ⇒ Types::CreateEmailIdentityResponse
Starts the process of verifying an email identity.
-
#create_email_identity_policy(params = {}) ⇒ Struct
Creates the specified sending authorization policy for the given identity (an email address or a domain).
-
#create_email_template(params = {}) ⇒ Struct
Creates an email template.
-
#create_export_job(params = {}) ⇒ Types::CreateExportJobResponse
Creates an export job for a data source and destination.
-
#create_import_job(params = {}) ⇒ Types::CreateImportJobResponse
Creates an import job for a data destination.
-
#delete_configuration_set(params = {}) ⇒ Struct
Delete an existing configuration set.
-
#delete_configuration_set_event_destination(params = {}) ⇒ Struct
Delete an event destination.
-
#delete_contact(params = {}) ⇒ Struct
Removes a contact from a contact list.
-
#delete_contact_list(params = {}) ⇒ Struct
Deletes a contact list and all of the contacts on that list.
-
#delete_custom_verification_email_template(params = {}) ⇒ Struct
Deletes an existing custom verification email template.
-
#delete_dedicated_ip_pool(params = {}) ⇒ Struct
Delete a dedicated IP pool.
-
#delete_email_identity(params = {}) ⇒ Struct
Deletes an email identity.
-
#delete_email_identity_policy(params = {}) ⇒ Struct
Deletes the specified sending authorization policy for the given identity (an email address or a domain).
-
#delete_email_template(params = {}) ⇒ Struct
Deletes an email template.
-
#delete_suppressed_destination(params = {}) ⇒ Struct
Removes an email address from the suppression list for your account.
-
#get_account(params = {}) ⇒ Types::GetAccountResponse
Obtain information about the email-sending status and capabilities of your Amazon SES account in the current Amazon Web Services Region.
-
#get_blacklist_reports(params = {}) ⇒ Types::GetBlacklistReportsResponse
Retrieve a list of the blacklists that your dedicated IP addresses appear on.
-
#get_configuration_set(params = {}) ⇒ Types::GetConfigurationSetResponse
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(params = {}) ⇒ Types::GetConfigurationSetEventDestinationsResponse
Retrieve a list of event destinations that are associated with a configuration set.
-
#get_contact(params = {}) ⇒ Types::GetContactResponse
Returns a contact from a contact list.
-
#get_contact_list(params = {}) ⇒ Types::GetContactListResponse
Returns contact list metadata.
-
#get_custom_verification_email_template(params = {}) ⇒ Types::GetCustomVerificationEmailTemplateResponse
Returns the custom email verification template for the template name you specify.
-
#get_dedicated_ip(params = {}) ⇒ Types::GetDedicatedIpResponse
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(params = {}) ⇒ Types::GetDedicatedIpPoolResponse
Retrieve information about the dedicated pool.
-
#get_dedicated_ips(params = {}) ⇒ Types::GetDedicatedIpsResponse
List the dedicated IP addresses that are associated with your Amazon Web Services account.
-
#get_deliverability_dashboard_options(params = {}) ⇒ Types::GetDeliverabilityDashboardOptionsResponse
Retrieve information about the status of the Deliverability dashboard for your account.
-
#get_deliverability_test_report(params = {}) ⇒ Types::GetDeliverabilityTestReportResponse
Retrieve the results of a predictive inbox placement test.
-
#get_domain_deliverability_campaign(params = {}) ⇒ Types::GetDomainDeliverabilityCampaignResponse
Retrieve all the deliverability data for a specific campaign.
-
#get_domain_statistics_report(params = {}) ⇒ Types::GetDomainStatisticsReportResponse
Retrieve inbox placement and engagement rates for the domains that you use to send email.
-
#get_email_identity(params = {}) ⇒ Types::GetEmailIdentityResponse
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(params = {}) ⇒ Types::GetEmailIdentityPoliciesResponse
Returns the requested sending authorization policies for the given identity (an email address or a domain).
-
#get_email_template(params = {}) ⇒ Types::GetEmailTemplateResponse
Displays the template object (which includes the subject line, HTML part and text part) for the template you specify.
-
#get_export_job(params = {}) ⇒ Types::GetExportJobResponse
Provides information about an export job.
-
#get_import_job(params = {}) ⇒ Types::GetImportJobResponse
Provides information about an import job.
-
#get_message_insights(params = {}) ⇒ Types::GetMessageInsightsResponse
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(params = {}) ⇒ Types::GetSuppressedDestinationResponse
Retrieves information about a specific email address that's on the suppression list for your account.
-
#list_configuration_sets(params = {}) ⇒ Types::ListConfigurationSetsResponse
List all of the configuration sets associated with your account in the current region.
-
#list_contact_lists(params = {}) ⇒ Types::ListContactListsResponse
Lists all of the contact lists available.
-
#list_contacts(params = {}) ⇒ Types::ListContactsResponse
Lists the contacts present in a specific contact list.
-
#list_custom_verification_email_templates(params = {}) ⇒ Types::ListCustomVerificationEmailTemplatesResponse
Lists the existing custom verification email templates for your account in the current Amazon Web Services Region.
-
#list_dedicated_ip_pools(params = {}) ⇒ Types::ListDedicatedIpPoolsResponse
List all of the dedicated IP pools that exist in your Amazon Web Services account in the current Region.
-
#list_deliverability_test_reports(params = {}) ⇒ Types::ListDeliverabilityTestReportsResponse
Show a list of the predictive inbox placement tests that you've performed, regardless of their statuses.
-
#list_domain_deliverability_campaigns(params = {}) ⇒ Types::ListDomainDeliverabilityCampaignsResponse
Retrieve deliverability data for all the campaigns that used a specific domain to send email during a specified time range.
-
#list_email_identities(params = {}) ⇒ Types::ListEmailIdentitiesResponse
Returns a list of all of the email identities that are associated with your Amazon Web Services account.
-
#list_email_templates(params = {}) ⇒ Types::ListEmailTemplatesResponse
Lists the email templates present in your Amazon SES account in the current Amazon Web Services Region.
-
#list_export_jobs(params = {}) ⇒ Types::ListExportJobsResponse
Lists all of the export jobs.
-
#list_import_jobs(params = {}) ⇒ Types::ListImportJobsResponse
Lists all of the import jobs.
-
#list_recommendations(params = {}) ⇒ Types::ListRecommendationsResponse
Lists the recommendations present in your Amazon SES account in the current Amazon Web Services Region.
-
#list_suppressed_destinations(params = {}) ⇒ Types::ListSuppressedDestinationsResponse
Retrieves a list of email addresses that are on the suppression list for your account.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Retrieve a list of the tags (keys and values) that are associated with a specified resource.
-
#put_account_dedicated_ip_warmup_attributes(params = {}) ⇒ Struct
Enable or disable the automatic warm-up feature for dedicated IP addresses.
-
#put_account_details(params = {}) ⇒ Struct
Update your Amazon SES account details.
-
#put_account_sending_attributes(params = {}) ⇒ Struct
Enable or disable the ability of your account to send email.
-
#put_account_suppression_attributes(params = {}) ⇒ Struct
Change the settings for the account-level suppression list.
-
#put_account_vdm_attributes(params = {}) ⇒ Struct
Update your Amazon SES account VDM attributes.
-
#put_configuration_set_delivery_options(params = {}) ⇒ Struct
Associate a configuration set with a dedicated IP pool.
-
#put_configuration_set_reputation_options(params = {}) ⇒ Struct
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(params = {}) ⇒ Struct
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(params = {}) ⇒ Struct
Specify the account suppression list preferences for a configuration set.
-
#put_configuration_set_tracking_options(params = {}) ⇒ Struct
Specify a custom domain to use for open and click tracking elements in email that you send.
-
#put_configuration_set_vdm_options(params = {}) ⇒ Struct
Specify VDM preferences for email that you send using the configuration set.
-
#put_dedicated_ip_in_pool(params = {}) ⇒ Struct
Move a dedicated IP address to an existing dedicated IP pool.
-
#put_dedicated_ip_pool_scaling_attributes(params = {}) ⇒ Struct
Used to convert a dedicated IP pool to a different scaling mode.
-
#put_dedicated_ip_warmup_attributes(params = {}) ⇒ Struct
Returns an empty response.
-
#put_deliverability_dashboard_option(params = {}) ⇒ Struct
Enable or disable the Deliverability dashboard.
-
#put_email_identity_configuration_set_attributes(params = {}) ⇒ Struct
Used to associate a configuration set with an email identity.
-
#put_email_identity_dkim_attributes(params = {}) ⇒ Struct
Used to enable or disable DKIM authentication for an email identity.
-
#put_email_identity_dkim_signing_attributes(params = {}) ⇒ Types::PutEmailIdentityDkimSigningAttributesResponse
Used to configure or change the DKIM authentication settings for an email domain identity.
-
#put_email_identity_feedback_attributes(params = {}) ⇒ Struct
Used to enable or disable feedback forwarding for an identity.
-
#put_email_identity_mail_from_attributes(params = {}) ⇒ Struct
Used to enable or disable the custom Mail-From domain configuration for an email identity.
-
#put_suppressed_destination(params = {}) ⇒ Struct
Adds an email address to the suppression list for your account.
-
#send_bulk_email(params = {}) ⇒ Types::SendBulkEmailResponse
Composes an email message to multiple destinations.
-
#send_custom_verification_email(params = {}) ⇒ Types::SendCustomVerificationEmailResponse
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(params = {}) ⇒ Types::SendEmailResponse
Sends an email message.
-
#tag_resource(params = {}) ⇒ Struct
Add one or more tags (keys and values) to a specified resource.
-
#test_render_email_template(params = {}) ⇒ Types::TestRenderEmailTemplateResponse
Creates a preview of the MIME content of an email when provided with a template and a set of replacement data.
-
#untag_resource(params = {}) ⇒ Struct
Remove one or more tags (keys and values) from a specified resource.
-
#update_configuration_set_event_destination(params = {}) ⇒ Struct
Update the configuration of an event destination for a configuration set.
-
#update_contact(params = {}) ⇒ Struct
Updates a contact's preferences for a list.
-
#update_contact_list(params = {}) ⇒ Struct
Updates contact list metadata.
-
#update_custom_verification_email_template(params = {}) ⇒ Struct
Updates an existing custom verification email template.
-
#update_email_identity_policy(params = {}) ⇒ Struct
Updates the specified sending authorization policy for the given identity (an email address or a domain).
-
#update_email_template(params = {}) ⇒ Struct
Updates an email template.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
385 386 387 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 385 def initialize(*args) super end |
Instance Method Details
#batch_get_metric_data(params = {}) ⇒ Types::BatchGetMetricDataResponse
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).
439 440 441 442 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 439 def batch_get_metric_data(params = {}, = {}) req = build_request(:batch_get_metric_data, params) req.send_request() end |
#cancel_export_job(params = {}) ⇒ Struct
Cancels an export job.
470 471 472 473 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 470 def cancel_export_job(params = {}, = {}) req = build_request(:cancel_export_job, params) req.send_request() end |
#create_configuration_set(params = {}) ⇒ Struct
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.
558 559 560 561 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 558 def create_configuration_set(params = {}, = {}) req = build_request(:create_configuration_set, params) req.send_request() end |
#create_configuration_set_event_destination(params = {}) ⇒ Struct
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.
620 621 622 623 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 620 def create_configuration_set_event_destination(params = {}, = {}) req = build_request(:create_configuration_set_event_destination, params) req.send_request() end |
#create_contact(params = {}) ⇒ Struct
Creates a contact, which is an end-user who is receiving the email, and adds them to a contact list.
666 667 668 669 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 666 def create_contact(params = {}, = {}) req = build_request(:create_contact, params) req.send_request() end |
#create_contact_list(params = {}) ⇒ Struct
Creates a contact list.
713 714 715 716 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 713 def create_contact_list(params = {}, = {}) req = build_request(:create_contact_list, params) req.send_request() end |
#create_custom_verification_email_template(params = {}) ⇒ Struct
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.
774 775 776 777 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 774 def create_custom_verification_email_template(params = {}, = {}) req = build_request(:create_custom_verification_email_template, params) req.send_request() end |
#create_dedicated_ip_pool(params = {}) ⇒ Struct
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.
814 815 816 817 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 814 def create_dedicated_ip_pool(params = {}, = {}) req = build_request(:create_dedicated_ip_pool, params) req.send_request() end |
#create_deliverability_test_report(params = {}) ⇒ Types::CreateDeliverabilityTestReportResponse
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.
898 899 900 901 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 898 def create_deliverability_test_report(params = {}, = {}) req = build_request(:create_deliverability_test_report, params) req.send_request() end |
#create_email_identity(params = {}) ⇒ Types::CreateEmailIdentityResponse
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.
1009 1010 1011 1012 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 1009 def create_email_identity(params = {}, = {}) req = build_request(:create_email_identity, params) req.send_request() end |
#create_email_identity_policy(params = {}) ⇒ Struct
Creates the specified sending authorization policy for the given identity (an email address or a domain).
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.
1065 1066 1067 1068 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 1065 def create_email_identity_policy(params = {}, = {}) req = build_request(:create_email_identity_policy, params) req.send_request() end |
#create_email_template(params = {}) ⇒ Struct
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.
1105 1106 1107 1108 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 1105 def create_email_template(params = {}, = {}) req = build_request(:create_email_template, params) req.send_request() end |
#create_export_job(params = {}) ⇒ Types::CreateExportJobResponse
Creates an export job for a data source and destination.
You can execute this operation no more than once per second.
1251 1252 1253 1254 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 1251 def create_export_job(params = {}, = {}) req = build_request(:create_export_job, params) req.send_request() end |
#create_import_job(params = {}) ⇒ Types::CreateImportJobResponse
Creates an import job for a data destination.
1294 1295 1296 1297 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 1294 def create_import_job(params = {}, = {}) req = build_request(:create_import_job, params) req.send_request() end |
#delete_configuration_set(params = {}) ⇒ Struct
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.
1322 1323 1324 1325 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 1322 def delete_configuration_set(params = {}, = {}) req = build_request(:delete_configuration_set, params) req.send_request() end |
#delete_configuration_set_event_destination(params = {}) ⇒ Struct
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.
1356 1357 1358 1359 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 1356 def delete_configuration_set_event_destination(params = {}, = {}) req = build_request(:delete_configuration_set_event_destination, params) req.send_request() end |
#delete_contact(params = {}) ⇒ Struct
Removes a contact from a contact list.
1382 1383 1384 1385 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 1382 def delete_contact(params = {}, = {}) req = build_request(:delete_contact, params) req.send_request() end |
#delete_contact_list(params = {}) ⇒ Struct
Deletes a contact list and all of the contacts on that list.
1404 1405 1406 1407 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 1404 def delete_contact_list(params = {}, = {}) req = build_request(:delete_contact_list, params) req.send_request() end |
#delete_custom_verification_email_template(params = {}) ⇒ Struct
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.
1437 1438 1439 1440 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 1437 def delete_custom_verification_email_template(params = {}, = {}) req = build_request(:delete_custom_verification_email_template, params) req.send_request() end |
#delete_dedicated_ip_pool(params = {}) ⇒ Struct
Delete a dedicated IP pool.
1459 1460 1461 1462 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 1459 def delete_dedicated_ip_pool(params = {}, = {}) req = build_request(:delete_dedicated_ip_pool, params) req.send_request() end |
#delete_email_identity(params = {}) ⇒ Struct
Deletes an email identity. An identity can be either an email address or a domain name.
1482 1483 1484 1485 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 1482 def delete_email_identity(params = {}, = {}) req = build_request(:delete_email_identity, params) req.send_request() end |
#delete_email_identity_policy(params = {}) ⇒ Struct
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.
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.
1528 1529 1530 1531 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 1528 def delete_email_identity_policy(params = {}, = {}) req = build_request(:delete_email_identity_policy, params) req.send_request() end |
#delete_email_template(params = {}) ⇒ Struct
Deletes an email template.
You can execute this operation no more than once per second.
1552 1553 1554 1555 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 1552 def delete_email_template(params = {}, = {}) req = build_request(:delete_email_template, params) req.send_request() end |
#delete_suppressed_destination(params = {}) ⇒ Struct
Removes an email address from the suppression list for your account.
1575 1576 1577 1578 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 1575 def delete_suppressed_destination(params = {}, = {}) req = build_request(:delete_suppressed_destination, params) req.send_request() end |
#get_account(params = {}) ⇒ Types::GetAccountResponse
Obtain information about the email-sending status and capabilities of your Amazon SES account in the current Amazon Web Services Region.
1621 1622 1623 1624 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 1621 def get_account(params = {}, = {}) req = build_request(:get_account, params) req.send_request() end |
#get_blacklist_reports(params = {}) ⇒ Types::GetBlacklistReportsResponse
Retrieve a list of the blacklists that your dedicated IP addresses appear on.
1656 1657 1658 1659 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 1656 def get_blacklist_reports(params = {}, = {}) req = build_request(:get_blacklist_reports, params) req.send_request() end |
#get_configuration_set(params = {}) ⇒ Types::GetConfigurationSetResponse
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.
1712 1713 1714 1715 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 1712 def get_configuration_set(params = {}, = {}) req = build_request(:get_configuration_set, params) req.send_request() end |
#get_configuration_set_event_destinations(params = {}) ⇒ Types::GetConfigurationSetEventDestinationsResponse
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.
1760 1761 1762 1763 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 1760 def get_configuration_set_event_destinations(params = {}, = {}) req = build_request(:get_configuration_set_event_destinations, params) req.send_request() end |
#get_contact(params = {}) ⇒ Types::GetContactResponse
Returns a contact from a contact list.
1810 1811 1812 1813 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 1810 def get_contact(params = {}, = {}) req = build_request(:get_contact, params) req.send_request() end |
#get_contact_list(params = {}) ⇒ Types::GetContactListResponse
Returns contact list metadata. It does not return any information about the contacts present in the list.
1855 1856 1857 1858 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 1855 def get_contact_list(params = {}, = {}) req = build_request(:get_contact_list, params) req.send_request() end |
#get_custom_verification_email_template(params = {}) ⇒ Types::GetCustomVerificationEmailTemplateResponse
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.
1905 1906 1907 1908 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 1905 def get_custom_verification_email_template(params = {}, = {}) req = build_request(:get_custom_verification_email_template, params) req.send_request() end |
#get_dedicated_ip(params = {}) ⇒ Types::GetDedicatedIpResponse
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.
1940 1941 1942 1943 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 1940 def get_dedicated_ip(params = {}, = {}) req = build_request(:get_dedicated_ip, params) req.send_request() end |
#get_dedicated_ip_pool(params = {}) ⇒ Types::GetDedicatedIpPoolResponse
Retrieve information about the dedicated pool.
1969 1970 1971 1972 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 1969 def get_dedicated_ip_pool(params = {}, = {}) req = build_request(:get_dedicated_ip_pool, params) req.send_request() end |
#get_dedicated_ips(params = {}) ⇒ Types::GetDedicatedIpsResponse
List the dedicated IP addresses that are associated with your Amazon Web Services account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2019 2020 2021 2022 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 2019 def get_dedicated_ips(params = {}, = {}) req = build_request(:get_dedicated_ips, params) req.send_request() end |
#get_deliverability_dashboard_options(params = {}) ⇒ Types::GetDeliverabilityDashboardOptionsResponse
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.
2070 2071 2072 2073 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 2070 def (params = {}, = {}) req = build_request(:get_deliverability_dashboard_options, params) req.send_request() end |
#get_deliverability_test_report(params = {}) ⇒ Types::GetDeliverabilityTestReportResponse
Retrieve the results of a predictive inbox placement test.
2123 2124 2125 2126 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 2123 def get_deliverability_test_report(params = {}, = {}) req = build_request(:get_deliverability_test_report, params) req.send_request() end |
#get_domain_deliverability_campaign(params = {}) ⇒ Types::GetDomainDeliverabilityCampaignResponse
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.
2169 2170 2171 2172 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 2169 def get_domain_deliverability_campaign(params = {}, = {}) req = build_request(:get_domain_deliverability_campaign, params) req.send_request() end |
#get_domain_statistics_report(params = {}) ⇒ Types::GetDomainStatisticsReportResponse
Retrieve inbox placement and engagement rates for the domains that you use to send email.
2232 2233 2234 2235 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 2232 def get_domain_statistics_report(params = {}, = {}) req = build_request(:get_domain_statistics_report, params) req.send_request() end |
#get_email_identity(params = {}) ⇒ Types::GetEmailIdentityResponse
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.
2290 2291 2292 2293 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 2290 def get_email_identity(params = {}, = {}) req = build_request(:get_email_identity, params) req.send_request() end |
#get_email_identity_policies(params = {}) ⇒ Types::GetEmailIdentityPoliciesResponse
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.
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.
2337 2338 2339 2340 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 2337 def get_email_identity_policies(params = {}, = {}) req = build_request(:get_email_identity_policies, params) req.send_request() end |
#get_email_template(params = {}) ⇒ Types::GetEmailTemplateResponse
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.
2372 2373 2374 2375 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 2372 def get_email_template(params = {}, = {}) req = build_request(:get_email_template, params) req.send_request() end |
#get_export_job(params = {}) ⇒ Types::GetExportJobResponse
Provides information about an export job.
2504 2505 2506 2507 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 2504 def get_export_job(params = {}, = {}) req = build_request(:get_export_job, params) req.send_request() end |
#get_import_job(params = {}) ⇒ Types::GetImportJobResponse
Provides information about an import job.
2552 2553 2554 2555 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 2552 def get_import_job(params = {}, = {}) req = build_request(:get_import_job, params) req.send_request() end |
#get_message_insights(params = {}) ⇒ Types::GetMessageInsightsResponse
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.
2663 2664 2665 2666 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 2663 def (params = {}, = {}) req = build_request(:get_message_insights, params) req.send_request() end |
#get_suppressed_destination(params = {}) ⇒ Types::GetSuppressedDestinationResponse
Retrieves information about a specific email address that's on the suppression list for your account.
2696 2697 2698 2699 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 2696 def get_suppressed_destination(params = {}, = {}) req = build_request(:get_suppressed_destination, params) req.send_request() end |
#list_configuration_sets(params = {}) ⇒ Types::ListConfigurationSetsResponse
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2744 2745 2746 2747 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 2744 def list_configuration_sets(params = {}, = {}) req = build_request(:list_configuration_sets, params) req.send_request() end |
#list_contact_lists(params = {}) ⇒ Types::ListContactListsResponse
Lists all of the contact lists available.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2789 2790 2791 2792 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 2789 def list_contact_lists(params = {}, = {}) req = build_request(:list_contact_lists, params) req.send_request() end |
#list_contacts(params = {}) ⇒ Types::ListContactsResponse
Lists the contacts present in a specific contact list.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2856 2857 2858 2859 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 2856 def list_contacts(params = {}, = {}) req = build_request(:list_contacts, params) req.send_request() end |
#list_custom_verification_email_templates(params = {}) ⇒ Types::ListCustomVerificationEmailTemplatesResponse
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2917 2918 2919 2920 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 2917 def list_custom_verification_email_templates(params = {}, = {}) req = build_request(:list_custom_verification_email_templates, params) req.send_request() end |
#list_dedicated_ip_pools(params = {}) ⇒ Types::ListDedicatedIpPoolsResponse
List all of the dedicated IP pools that exist in your Amazon Web Services account in the current Region.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2959 2960 2961 2962 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 2959 def list_dedicated_ip_pools(params = {}, = {}) req = build_request(:list_dedicated_ip_pools, params) req.send_request() end |
#list_deliverability_test_reports(params = {}) ⇒ Types::ListDeliverabilityTestReportsResponse
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3013 3014 3015 3016 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 3013 def list_deliverability_test_reports(params = {}, = {}) req = build_request(:list_deliverability_test_reports, params) req.send_request() end |
#list_domain_deliverability_campaigns(params = {}) ⇒ Types::ListDomainDeliverabilityCampaignsResponse
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3088 3089 3090 3091 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 3088 def list_domain_deliverability_campaigns(params = {}, = {}) req = build_request(:list_domain_deliverability_campaigns, params) req.send_request() end |
#list_email_identities(params = {}) ⇒ Types::ListEmailIdentitiesResponse
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3139 3140 3141 3142 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 3139 def list_email_identities(params = {}, = {}) req = build_request(:list_email_identities, params) req.send_request() end |
#list_email_templates(params = {}) ⇒ Types::ListEmailTemplatesResponse
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3187 3188 3189 3190 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 3187 def list_email_templates(params = {}, = {}) req = build_request(:list_email_templates, params) req.send_request() end |
#list_export_jobs(params = {}) ⇒ Types::ListExportJobsResponse
Lists all of the export jobs.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3265 3266 3267 3268 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 3265 def list_export_jobs(params = {}, = {}) req = build_request(:list_export_jobs, params) req.send_request() end |
#list_import_jobs(params = {}) ⇒ Types::ListImportJobsResponse
Lists all of the import jobs.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3321 3322 3323 3324 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 3321 def list_import_jobs(params = {}, = {}) req = build_request(:list_import_jobs, params) req.send_request() end |
#list_recommendations(params = {}) ⇒ Types::ListRecommendationsResponse
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3382 3383 3384 3385 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 3382 def list_recommendations(params = {}, = {}) req = build_request(:list_recommendations, params) req.send_request() end |
#list_suppressed_destinations(params = {}) ⇒ Types::ListSuppressedDestinationsResponse
Retrieves a list of email addresses that are on the suppression list for your account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3442 3443 3444 3445 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 3442 def list_suppressed_destinations(params = {}, = {}) req = build_request(:list_suppressed_destinations, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
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.
3478 3479 3480 3481 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 3478 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#put_account_dedicated_ip_warmup_attributes(params = {}) ⇒ Struct
Enable or disable the automatic warm-up feature for dedicated IP addresses.
3504 3505 3506 3507 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 3504 def put_account_dedicated_ip_warmup_attributes(params = {}, = {}) req = build_request(:put_account_dedicated_ip_warmup_attributes, params) req.send_request() end |
#put_account_details(params = {}) ⇒ Struct
Update your Amazon SES account details.
3560 3561 3562 3563 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 3560 def put_account_details(params = {}, = {}) req = build_request(:put_account_details, params) req.send_request() end |
#put_account_sending_attributes(params = {}) ⇒ Struct
Enable or disable the ability of your account to send email.
3590 3591 3592 3593 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 3590 def put_account_sending_attributes(params = {}, = {}) req = build_request(:put_account_sending_attributes, params) req.send_request() end |
#put_account_suppression_attributes(params = {}) ⇒ Struct
Change the settings for the account-level suppression list.
3622 3623 3624 3625 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 3622 def put_account_suppression_attributes(params = {}, = {}) req = build_request(:put_account_suppression_attributes, params) req.send_request() end |
#put_account_vdm_attributes(params = {}) ⇒ Struct
Update your Amazon SES account VDM attributes.
You can execute this operation no more than once per second.
3654 3655 3656 3657 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 3654 def put_account_vdm_attributes(params = {}, = {}) req = build_request(:put_account_vdm_attributes, params) req.send_request() end |
#put_configuration_set_delivery_options(params = {}) ⇒ Struct
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.
3692 3693 3694 3695 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 3692 def (params = {}, = {}) req = build_request(:put_configuration_set_delivery_options, params) req.send_request() end |
#put_configuration_set_reputation_options(params = {}) ⇒ Struct
Enable or disable collection of reputation metrics for emails that you send using a particular configuration set in a specific Amazon Web Services Region.
3722 3723 3724 3725 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 3722 def (params = {}, = {}) req = build_request(:put_configuration_set_reputation_options, params) req.send_request() end |
#put_configuration_set_sending_options(params = {}) ⇒ Struct
Enable or disable email sending for messages that use a particular configuration set in a specific Amazon Web Services Region.
3751 3752 3753 3754 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 3751 def (params = {}, = {}) req = build_request(:put_configuration_set_sending_options, params) req.send_request() end |
#put_configuration_set_suppression_options(params = {}) ⇒ Struct
Specify the account suppression list preferences for a configuration set.
3789 3790 3791 3792 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 3789 def (params = {}, = {}) req = build_request(:put_configuration_set_suppression_options, params) req.send_request() end |
#put_configuration_set_tracking_options(params = {}) ⇒ Struct
Specify a custom domain to use for open and click tracking elements in email that you send.
3816 3817 3818 3819 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 3816 def (params = {}, = {}) req = build_request(:put_configuration_set_tracking_options, params) req.send_request() end |
#put_configuration_set_vdm_options(params = {}) ⇒ Struct
Specify VDM preferences for email that you send using the configuration set.
You can execute this operation no more than once per second.
3852 3853 3854 3855 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 3852 def (params = {}, = {}) req = build_request(:put_configuration_set_vdm_options, params) req.send_request() end |
#put_dedicated_ip_in_pool(params = {}) ⇒ Struct
Move a dedicated IP address to an existing dedicated IP pool.
The dedicated IP pool you specify must already exist. You can create a
new pool by using the CreateDedicatedIpPool
operation.
3889 3890 3891 3892 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 3889 def put_dedicated_ip_in_pool(params = {}, = {}) req = build_request(:put_dedicated_ip_in_pool, params) req.send_request() end |
#put_dedicated_ip_pool_scaling_attributes(params = {}) ⇒ Struct
Used to convert a dedicated IP pool to a different scaling mode.
MANAGED
pools cannot be converted to STANDARD
scaling mode.
3938 3939 3940 3941 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 3938 def put_dedicated_ip_pool_scaling_attributes(params = {}, = {}) req = build_request(:put_dedicated_ip_pool_scaling_attributes, params) req.send_request() end |
#put_dedicated_ip_warmup_attributes(params = {}) ⇒ Struct
Returns an empty response.
3964 3965 3966 3967 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 3964 def put_dedicated_ip_warmup_attributes(params = {}, = {}) req = build_request(:put_dedicated_ip_warmup_attributes, params) req.send_request() end |
#put_deliverability_dashboard_option(params = {}) ⇒ Struct
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.
4015 4016 4017 4018 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 4015 def put_deliverability_dashboard_option(params = {}, = {}) req = build_request(:put_deliverability_dashboard_option, params) req.send_request() end |
#put_email_identity_configuration_set_attributes(params = {}) ⇒ Struct
Used to associate a configuration set with an email identity.
4041 4042 4043 4044 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 4041 def put_email_identity_configuration_set_attributes(params = {}, = {}) req = build_request(:put_email_identity_configuration_set_attributes, params) req.send_request() end |
#put_email_identity_dkim_attributes(params = {}) ⇒ Struct
Used to enable or disable DKIM authentication for an email identity.
4071 4072 4073 4074 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 4071 def put_email_identity_dkim_attributes(params = {}, = {}) req = build_request(:put_email_identity_dkim_attributes, params) req.send_request() end |
#put_email_identity_dkim_signing_attributes(params = {}) ⇒ Types::PutEmailIdentityDkimSigningAttributesResponse
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.
4146 4147 4148 4149 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 4146 def put_email_identity_dkim_signing_attributes(params = {}, = {}) req = build_request(:put_email_identity_dkim_signing_attributes, params) req.send_request() end |
#put_email_identity_feedback_attributes(params = {}) ⇒ Struct
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).
4194 4195 4196 4197 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 4194 def put_email_identity_feedback_attributes(params = {}, = {}) req = build_request(:put_email_identity_feedback_attributes, params) req.send_request() end |
#put_email_identity_mail_from_attributes(params = {}) ⇒ Struct
Used to enable or disable the custom Mail-From domain configuration for an email identity.
4242 4243 4244 4245 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 4242 def put_email_identity_mail_from_attributes(params = {}, = {}) req = build_request(:put_email_identity_mail_from_attributes, params) req.send_request() end |
#put_suppressed_destination(params = {}) ⇒ Struct
Adds an email address to the suppression list for your account.
4270 4271 4272 4273 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 4270 def put_suppressed_destination(params = {}, = {}) req = build_request(:put_suppressed_destination, params) req.send_request() end |
#send_bulk_email(params = {}) ⇒ Types::SendBulkEmailResponse
Composes an email message to multiple destinations.
4404 4405 4406 4407 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 4404 def send_bulk_email(params = {}, = {}) req = build_request(:send_bulk_email, params) req.send_request() end |
#send_custom_verification_email(params = {}) ⇒ Types::SendCustomVerificationEmailResponse
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.
4456 4457 4458 4459 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 4456 def send_custom_verification_email(params = {}, = {}) req = build_request(:send_custom_verification_email, params) req.send_request() end |
#send_email(params = {}) ⇒ Types::SendEmailResponse
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.
4618 4619 4620 4621 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 4618 def send_email(params = {}, = {}) req = build_request(:send_email, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
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.
4662 4663 4664 4665 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 4662 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#test_render_email_template(params = {}) ⇒ Types::TestRenderEmailTemplateResponse
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.
4699 4700 4701 4702 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 4699 def test_render_email_template(params = {}, = {}) req = build_request(:test_render_email_template, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Remove one or more tags (keys and values) from a specified resource.
4733 4734 4735 4736 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 4733 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_configuration_set_event_destination(params = {}) ⇒ Struct
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.
4794 4795 4796 4797 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 4794 def update_configuration_set_event_destination(params = {}, = {}) req = build_request(:update_configuration_set_event_destination, params) req.send_request() end |
#update_contact(params = {}) ⇒ Struct
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.
4841 4842 4843 4844 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 4841 def update_contact(params = {}, = {}) req = build_request(:update_contact, params) req.send_request() end |
#update_contact_list(params = {}) ⇒ Struct
Updates contact list metadata. This operation does a complete replacement.
4880 4881 4882 4883 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 4880 def update_contact_list(params = {}, = {}) req = build_request(:update_contact_list, params) req.send_request() end |
#update_custom_verification_email_template(params = {}) ⇒ Struct
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.
4942 4943 4944 4945 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 4942 def update_custom_verification_email_template(params = {}, = {}) req = build_request(:update_custom_verification_email_template, params) req.send_request() end |
#update_email_identity_policy(params = {}) ⇒ Struct
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.
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.
4999 5000 5001 5002 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 4999 def update_email_identity_policy(params = {}, = {}) req = build_request(:update_email_identity_policy, params) req.send_request() end |
#update_email_template(params = {}) ⇒ Struct
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.
5039 5040 5041 5042 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 5039 def update_email_template(params = {}, = {}) req = build_request(:update_email_template, params) req.send_request() end |