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_archiving_options(params = {}) ⇒ Struct
Associate the configuration set with a MailManager archive.
-
#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.
649 650 651 652 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 649 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.
712 713 714 715 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 712 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.
758 759 760 761 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 758 def create_contact(params = {}, = {}) req = build_request(:create_contact, params) req.send_request() end |
#create_contact_list(params = {}) ⇒ Struct
Creates a contact list.
805 806 807 808 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 805 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.
866 867 868 869 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 866 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.
906 907 908 909 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 906 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.
1007 1008 1009 1010 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 1007 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.
1119 1120 1121 1122 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 1119 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.
1175 1176 1177 1178 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 1175 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.
1215 1216 1217 1218 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 1215 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.
1361 1362 1363 1364 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 1361 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.
1404 1405 1406 1407 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 1404 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.
1462 1463 1464 1465 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 1462 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.
1490 1491 1492 1493 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 1490 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.
1523 1524 1525 1526 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 1523 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.
1549 1550 1551 1552 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 1549 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.
1571 1572 1573 1574 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 1571 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.
1604 1605 1606 1607 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 1604 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.
1626 1627 1628 1629 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 1626 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.
1649 1650 1651 1652 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 1649 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.
1695 1696 1697 1698 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 1695 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.
1719 1720 1721 1722 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 1719 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.
1750 1751 1752 1753 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 1750 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.
1773 1774 1775 1776 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 1773 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.
1819 1820 1821 1822 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 1819 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.
1854 1855 1856 1857 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 1854 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.
1914 1915 1916 1917 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 1914 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.
1962 1963 1964 1965 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 1962 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.
2012 2013 2014 2015 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 2012 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.
2057 2058 2059 2060 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 2057 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.
2107 2108 2109 2110 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 2107 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.
2142 2143 2144 2145 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 2142 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.
2171 2172 2173 2174 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 2171 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.
2221 2222 2223 2224 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 2221 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.
2272 2273 2274 2275 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 2272 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.
2325 2326 2327 2328 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 2325 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.
2371 2372 2373 2374 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 2371 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.
2434 2435 2436 2437 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 2434 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.
2499 2500 2501 2502 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 2499 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.
2546 2547 2548 2549 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 2546 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.
2581 2582 2583 2584 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 2581 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.
2713 2714 2715 2716 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 2713 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.
2761 2762 2763 2764 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 2761 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.
2872 2873 2874 2875 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 2872 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.
2914 2915 2916 2917 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 2914 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.
2947 2948 2949 2950 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 2947 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.
2995 2996 2997 2998 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 2995 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.
3040 3041 3042 3043 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 3040 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.
3107 3108 3109 3110 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 3107 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.
3168 3169 3170 3171 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 3168 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.
3210 3211 3212 3213 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 3210 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.
3264 3265 3266 3267 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 3264 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.
3339 3340 3341 3342 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 3339 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.
3390 3391 3392 3393 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 3390 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.
3438 3439 3440 3441 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 3438 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.
3516 3517 3518 3519 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 3516 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.
3572 3573 3574 3575 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 3572 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.
3624 3625 3626 3627 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 3624 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.
3685 3686 3687 3688 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 3685 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.
3745 3746 3747 3748 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 3745 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.
3781 3782 3783 3784 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 3781 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.
3807 3808 3809 3810 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 3807 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.
3861 3862 3863 3864 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 3861 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.
3891 3892 3893 3894 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 3891 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.
3923 3924 3925 3926 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 3923 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.
3955 3956 3957 3958 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 3955 def put_account_vdm_attributes(params = {}, = {}) req = build_request(:put_account_vdm_attributes, params) req.send_request() end |
#put_configuration_set_archiving_options(params = {}) ⇒ Struct
Associate the configuration set with a MailManager archive. When you
send email using the SendEmail
or SendBulkEmail
operations the
message as it will be given to the receiving SMTP server will be
archived, along with the recipient information.
4000 4001 4002 4003 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 4000 def (params = {}, = {}) req = build_request(:put_configuration_set_archiving_options, 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.
4045 4046 4047 4048 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 4045 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.
4075 4076 4077 4078 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 4075 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.
4104 4105 4106 4107 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 4104 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.
4142 4143 4144 4145 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 4142 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.
4178 4179 4180 4181 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 4178 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.
4214 4215 4216 4217 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 4214 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.
4251 4252 4253 4254 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 4251 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.
4300 4301 4302 4303 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 4300 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.
4326 4327 4328 4329 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 4326 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.
4377 4378 4379 4380 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 4377 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.
4403 4404 4405 4406 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 4403 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.
4433 4434 4435 4436 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 4433 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.
4509 4510 4511 4512 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 4509 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).
4557 4558 4559 4560 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 4557 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.
4605 4606 4607 4608 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 4605 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.
4633 4634 4635 4636 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 4633 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.
4788 4789 4790 4791 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 4788 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.
4840 4841 4842 4843 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 4840 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.
5023 5024 5025 5026 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 5023 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.
5067 5068 5069 5070 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 5067 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.
5104 5105 5106 5107 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 5104 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.
5138 5139 5140 5141 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 5138 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.
5201 5202 5203 5204 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 5201 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.
5252 5253 5254 5255 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 5252 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.
5291 5292 5293 5294 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 5291 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.
5353 5354 5355 5356 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 5353 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.
5410 5411 5412 5413 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 5410 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.
5450 5451 5452 5453 |
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/client.rb', line 5450 def update_email_template(params = {}, = {}) req = build_request(:update_email_template, params) req.send_request() end |