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.
-
#create_multi_region_endpoint(params = {}) ⇒ Types::CreateMultiRegionEndpointResponse
Creates a multi-region endpoint (global-endpoint).
-
#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_multi_region_endpoint(params = {}) ⇒ Types::DeleteMultiRegionEndpointResponse
Deletes a multi-region endpoint (global-endpoint).
-
#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_multi_region_endpoint(params = {}) ⇒ Types::GetMultiRegionEndpointResponse
Displays the multi-region endpoint (global-endpoint) configuration.
-
#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_multi_region_endpoints(params = {}) ⇒ Types::ListMultiRegionEndpointsResponse
List the multi-region endpoints (global-endpoints).
-
#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.
467 468 469 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 467 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).
521 522 523 524 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 521 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.
552 553 554 555 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 552 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.
642 643 644 645 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 642 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 EventBridge and associate a rule to send the event to the specified target.
A single configuration set can include more than one event destination.
705 706 707 708 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 705 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.
751 752 753 754 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 751 def create_contact(params = {}, = {}) req = build_request(:create_contact, params) req.send_request() end |
#create_contact_list(params = {}) ⇒ Struct
Creates a contact list.
798 799 800 801 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 798 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.
859 860 861 862 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 859 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.
899 900 901 902 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 899 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.
1000 1001 1002 1003 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 1000 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.
1112 1113 1114 1115 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 1112 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.
1168 1169 1170 1171 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 1168 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.
1208 1209 1210 1211 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 1208 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.
1354 1355 1356 1357 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 1354 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.
1397 1398 1399 1400 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 1397 def create_import_job(params = {}, = {}) req = build_request(:create_import_job, params) req.send_request() end |
#create_multi_region_endpoint(params = {}) ⇒ Types::CreateMultiRegionEndpointResponse
Creates a multi-region endpoint (global-endpoint).
The primary region is going to be the AWS-Region where the operation is executed. The secondary region has to be provided in request's parameters. From the data flow standpoint there is no difference between primary and secondary regions - sending traffic will be split equally between the two. The primary region is the region where the resource has been created and where it can be managed.
1455 1456 1457 1458 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 1455 def create_multi_region_endpoint(params = {}, = {}) req = build_request(:create_multi_region_endpoint, 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.
1483 1484 1485 1486 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 1483 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 EventBridge and associate a rule to send the event to the specified target.
1516 1517 1518 1519 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 1516 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.
1542 1543 1544 1545 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 1542 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.
1564 1565 1566 1567 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 1564 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.
1597 1598 1599 1600 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 1597 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.
1619 1620 1621 1622 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 1619 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.
1642 1643 1644 1645 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 1642 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.
1688 1689 1690 1691 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 1688 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.
1712 1713 1714 1715 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 1712 def delete_email_template(params = {}, = {}) req = build_request(:delete_email_template, params) req.send_request() end |
#delete_multi_region_endpoint(params = {}) ⇒ Types::DeleteMultiRegionEndpointResponse
Deletes a multi-region endpoint (global-endpoint).
Only multi-region endpoints (global-endpoints) whose primary region is the AWS-Region where operation is executed can be deleted.
1743 1744 1745 1746 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 1743 def delete_multi_region_endpoint(params = {}, = {}) req = build_request(:delete_multi_region_endpoint, params) req.send_request() end |
#delete_suppressed_destination(params = {}) ⇒ Struct
Removes an email address from the suppression list for your account.
1766 1767 1768 1769 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 1766 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.
1812 1813 1814 1815 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 1812 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.
1847 1848 1849 1850 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 1847 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.
1905 1906 1907 1908 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 1905 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 EventBridge and associate a rule to send the event to the specified target.
1953 1954 1955 1956 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 1953 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.
2003 2004 2005 2006 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 2003 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.
2048 2049 2050 2051 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 2048 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.
2098 2099 2100 2101 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 2098 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.
2133 2134 2135 2136 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 2133 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.
2162 2163 2164 2165 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 2162 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.
2212 2213 2214 2215 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 2212 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.
2263 2264 2265 2266 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 2263 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.
2316 2317 2318 2319 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 2316 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.
2362 2363 2364 2365 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 2362 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.
2425 2426 2427 2428 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 2425 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.
2490 2491 2492 2493 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 2490 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.
2537 2538 2539 2540 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 2537 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.
2572 2573 2574 2575 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 2572 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.
2704 2705 2706 2707 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 2704 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.
2752 2753 2754 2755 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 2752 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.
2863 2864 2865 2866 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 2863 def (params = {}, = {}) req = build_request(:get_message_insights, params) req.send_request() end |
#get_multi_region_endpoint(params = {}) ⇒ Types::GetMultiRegionEndpointResponse
Displays the multi-region endpoint (global-endpoint) configuration.
Only multi-region endpoints (global-endpoints) whose primary region is the AWS-Region where operation is executed can be displayed.
2905 2906 2907 2908 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 2905 def get_multi_region_endpoint(params = {}, = {}) req = build_request(:get_multi_region_endpoint, 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.
2938 2939 2940 2941 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 2938 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.
2986 2987 2988 2989 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 2986 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.
3031 3032 3033 3034 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 3031 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.
3098 3099 3100 3101 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 3098 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.
3159 3160 3161 3162 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 3159 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.
3201 3202 3203 3204 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 3201 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.
3255 3256 3257 3258 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 3255 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.
3330 3331 3332 3333 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 3330 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.
3381 3382 3383 3384 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 3381 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.
3429 3430 3431 3432 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 3429 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.
3507 3508 3509 3510 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 3507 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.
3563 3564 3565 3566 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 3563 def list_import_jobs(params = {}, = {}) req = build_request(:list_import_jobs, params) req.send_request() end |
#list_multi_region_endpoints(params = {}) ⇒ Types::ListMultiRegionEndpointsResponse
List the multi-region endpoints (global-endpoints).
Only multi-region endpoints (global-endpoints) whose primary region is the AWS-Region where operation is executed will be listed.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3615 3616 3617 3618 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 3615 def list_multi_region_endpoints(params = {}, = {}) req = build_request(:list_multi_region_endpoints, 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.
3676 3677 3678 3679 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 3676 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.
3736 3737 3738 3739 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 3736 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.
3772 3773 3774 3775 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 3772 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.
3798 3799 3800 3801 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 3798 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.
3852 3853 3854 3855 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 3852 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.
3882 3883 3884 3885 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 3882 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.
3914 3915 3916 3917 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 3914 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.
3946 3947 3948 3949 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 3946 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.
3991 3992 3993 3994 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 3991 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.
4021 4022 4023 4024 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 4021 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.
4050 4051 4052 4053 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 4050 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.
4088 4089 4090 4091 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 4088 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.
4124 4125 4126 4127 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 4124 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.
4160 4161 4162 4163 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 4160 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.
4197 4198 4199 4200 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 4197 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.
4246 4247 4248 4249 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 4246 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.
4272 4273 4274 4275 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 4272 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.
4323 4324 4325 4326 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 4323 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.
4349 4350 4351 4352 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 4349 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.
4379 4380 4381 4382 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 4379 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.
4455 4456 4457 4458 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 4455 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).
4503 4504 4505 4506 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 4503 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.
4551 4552 4553 4554 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 4551 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.
4579 4580 4581 4582 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 4579 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.
4734 4735 4736 4737 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 4734 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.
4786 4787 4788 4789 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 4786 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.
4969 4970 4971 4972 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 4969 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.
5013 5014 5015 5016 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 5013 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.
5050 5051 5052 5053 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 5050 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.
5084 5085 5086 5087 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 5084 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 EventBridge and associate a rule to send the event to the specified target.
5147 5148 5149 5150 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 5147 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.
TopicPreferences
object, not just the ones that need updating;
otherwise, all your existing preferences will be removed.
5198 5199 5200 5201 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 5198 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.
5237 5238 5239 5240 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 5237 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.
5299 5300 5301 5302 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 5299 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.
5356 5357 5358 5359 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 5356 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.
5396 5397 5398 5399 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 5396 def update_email_template(params = {}, = {}) req = build_request(:update_email_template, params) req.send_request() end |