Class: Aws::PinpointEmail::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::PinpointEmail::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-pinpointemail/lib/aws-sdk-pinpointemail/client.rb
Overview
An API client for PinpointEmail. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::PinpointEmail::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
-
#create_configuration_set(params = {}) ⇒ Struct
Create a configuration set.
-
#create_configuration_set_event_destination(params = {}) ⇒ Struct
Create an event destination.
-
#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
Verifies an email identity for use with Amazon Pinpoint.
-
#delete_configuration_set(params = {}) ⇒ Struct
Delete an existing configuration set.
-
#delete_configuration_set_event_destination(params = {}) ⇒ Struct
Delete an event destination.
-
#delete_dedicated_ip_pool(params = {}) ⇒ Struct
Delete a dedicated IP pool.
-
#delete_email_identity(params = {}) ⇒ Struct
Deletes an email identity that you previously verified for use with Amazon Pinpoint.
-
#get_account(params = {}) ⇒ Types::GetAccountResponse
Obtain information about the email-sending status and capabilities of your Amazon Pinpoint account in the current AWS 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_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_ips(params = {}) ⇒ Types::GetDedicatedIpsResponse
List the dedicated IP addresses that are associated with your Amazon Pinpoint account.
-
#get_deliverability_dashboard_options(params = {}) ⇒ Types::GetDeliverabilityDashboardOptionsResponse
Retrieve information about the status of the Deliverability dashboard for your Amazon Pinpoint 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 associated with your Amazon Pinpoint account, including the identity's verification status, its DKIM authentication status, and its custom Mail-From settings.
-
#list_configuration_sets(params = {}) ⇒ Types::ListConfigurationSetsResponse
List all of the configuration sets associated with your Amazon Pinpoint account in the current region.
-
#list_dedicated_ip_pools(params = {}) ⇒ Types::ListDedicatedIpPoolsResponse
List all of the dedicated IP pools that exist in your Amazon Pinpoint account in the current AWS 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 Pinpoint 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_sending_attributes(params = {}) ⇒ Struct
Enable or disable the ability of your account to send email.
-
#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 AWS Region.
-
#put_configuration_set_sending_options(params = {}) ⇒ Struct
Enable or disable email sending for messages that use a particular configuration set in a specific AWS Region.
-
#put_configuration_set_tracking_options(params = {}) ⇒ Struct
Specify a custom domain to use for open and click tracking elements in email that you send using Amazon Pinpoint.
-
#put_dedicated_ip_in_pool(params = {}) ⇒ Struct
Move a dedicated IP address to an existing dedicated IP pool.
-
#put_dedicated_ip_warmup_attributes(params = {}) ⇒ Struct
Returns an empty response.
-
#put_deliverability_dashboard_option(params = {}) ⇒ Struct
Enable or disable the Deliverability dashboard for your Amazon Pinpoint account.
-
#put_email_identity_dkim_attributes(params = {}) ⇒ Struct
Used to enable or disable DKIM authentication for an email 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.
-
#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.
-
#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.
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.
422 423 424 |
# File 'gems/aws-sdk-pinpointemail/lib/aws-sdk-pinpointemail/client.rb', line 422 def initialize(*args) super end |
Instance Method Details
#create_configuration_set(params = {}) ⇒ Struct
Create a configuration set. Configuration sets are groups of rules that you can apply to the emails you send using Amazon Pinpoint. 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.
491 492 493 494 |
# File 'gems/aws-sdk-pinpointemail/lib/aws-sdk-pinpointemail/client.rb', line 491 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. In Amazon Pinpoint, events include message sends, deliveries, opens, clicks, bounces, and complaints. Event destinations are places that you can send information about these events to. For example, you can send event data to Amazon SNS to receive notifications when you receive bounces or complaints, or you can use Amazon Kinesis Data Firehose to stream data to Amazon S3 for long-term storage.
A single configuration set can include more than one event destination.
554 555 556 557 |
# File 'gems/aws-sdk-pinpointemail/lib/aws-sdk-pinpointemail/client.rb', line 554 def create_configuration_set_event_destination(params = {}, = {}) req = build_request(:create_configuration_set_event_destination, 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 Pinpoint account. You can associate a pool with a configuration set. When you send an email that uses that configuration set, Amazon Pinpoint sends it using only the IP addresses in the associated pool.
590 591 592 593 |
# File 'gems/aws-sdk-pinpointemail/lib/aws-sdk-pinpointemail/client.rb', line 590 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
Pinpoint 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.
673 674 675 676 |
# File 'gems/aws-sdk-pinpointemail/lib/aws-sdk-pinpointemail/client.rb', line 673 def create_deliverability_test_report(params = {}, = {}) req = build_request(:create_deliverability_test_report, params) req.send_request() end |
#create_email_identity(params = {}) ⇒ Types::CreateEmailIdentityResponse
Verifies an email identity for use with Amazon Pinpoint. In Amazon Pinpoint, an identity is an email address or domain that you use when you send email. Before you can use an identity to send email with Amazon Pinpoint, you first have to verify it. By verifying an address, you demonstrate that you're the owner of the address, and that you've given Amazon Pinpoint permission to send email from the address.
When you verify an email address, Amazon Pinpoint 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, 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 Pinpoint detects these records in the DNS configuration for your domain. It usually takes around 72 hours to complete the domain verification process.
735 736 737 738 |
# File 'gems/aws-sdk-pinpointemail/lib/aws-sdk-pinpointemail/client.rb', line 735 def create_email_identity(params = {}, = {}) req = build_request(:create_email_identity, params) req.send_request() end |
#delete_configuration_set(params = {}) ⇒ Struct
Delete an existing configuration set.
In Amazon Pinpoint, 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.
763 764 765 766 |
# File 'gems/aws-sdk-pinpointemail/lib/aws-sdk-pinpointemail/client.rb', line 763 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.
In Amazon Pinpoint, events include message sends, deliveries, opens, clicks, bounces, and complaints. Event destinations are places that you can send information about these events to. For example, you can send event data to Amazon SNS to receive notifications when you receive bounces or complaints, or you can use Amazon Kinesis Data Firehose to stream data to Amazon S3 for long-term storage.
797 798 799 800 |
# File 'gems/aws-sdk-pinpointemail/lib/aws-sdk-pinpointemail/client.rb', line 797 def delete_configuration_set_event_destination(params = {}, = {}) req = build_request(:delete_configuration_set_event_destination, params) req.send_request() end |
#delete_dedicated_ip_pool(params = {}) ⇒ Struct
Delete a dedicated IP pool.
819 820 821 822 |
# File 'gems/aws-sdk-pinpointemail/lib/aws-sdk-pinpointemail/client.rb', line 819 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 that you previously verified for use with Amazon Pinpoint. An identity can be either an email address or a domain name.
844 845 846 847 |
# File 'gems/aws-sdk-pinpointemail/lib/aws-sdk-pinpointemail/client.rb', line 844 def delete_email_identity(params = {}, = {}) req = build_request(:delete_email_identity, params) req.send_request() end |
#get_account(params = {}) ⇒ Types::GetAccountResponse
Obtain information about the email-sending status and capabilities of your Amazon Pinpoint account in the current AWS Region.
874 875 876 877 |
# File 'gems/aws-sdk-pinpointemail/lib/aws-sdk-pinpointemail/client.rb', line 874 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.
909 910 911 912 |
# File 'gems/aws-sdk-pinpointemail/lib/aws-sdk-pinpointemail/client.rb', line 909 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.
In Amazon Pinpoint, 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.
960 961 962 963 |
# File 'gems/aws-sdk-pinpointemail/lib/aws-sdk-pinpointemail/client.rb', line 960 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.
In Amazon Pinpoint, events include message sends, deliveries, opens, clicks, bounces, and complaints. Event destinations are places that you can send information about these events to. For example, you can send event data to Amazon SNS to receive notifications when you receive bounces or complaints, or you can use Amazon Kinesis Data Firehose to stream data to Amazon S3 for long-term storage.
1008 1009 1010 1011 |
# File 'gems/aws-sdk-pinpointemail/lib/aws-sdk-pinpointemail/client.rb', line 1008 def get_configuration_set_event_destinations(params = {}, = {}) req = build_request(:get_configuration_set_event_destinations, 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.
1043 1044 1045 1046 |
# File 'gems/aws-sdk-pinpointemail/lib/aws-sdk-pinpointemail/client.rb', line 1043 def get_dedicated_ip(params = {}, = {}) req = build_request(:get_dedicated_ip, params) req.send_request() end |
#get_dedicated_ips(params = {}) ⇒ Types::GetDedicatedIpsResponse
List the dedicated IP addresses that are associated with your Amazon Pinpoint account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1093 1094 1095 1096 |
# File 'gems/aws-sdk-pinpointemail/lib/aws-sdk-pinpointemail/client.rb', line 1093 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 Amazon Pinpoint 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 using Amazon Pinpoint. 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 Pinpoint. For more information about the features and cost of a Deliverability dashboard subscription, see Amazon Pinpoint Pricing.
1145 1146 1147 1148 |
# File 'gems/aws-sdk-pinpointemail/lib/aws-sdk-pinpointemail/client.rb', line 1145 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.
1198 1199 1200 1201 |
# File 'gems/aws-sdk-pinpointemail/lib/aws-sdk-pinpointemail/client.rb', line 1198 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
(PutDeliverabilityDashboardOption
operation).
1248 1249 1250 1251 |
# File 'gems/aws-sdk-pinpointemail/lib/aws-sdk-pinpointemail/client.rb', line 1248 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.
1311 1312 1313 1314 |
# File 'gems/aws-sdk-pinpointemail/lib/aws-sdk-pinpointemail/client.rb', line 1311 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 associated with your Amazon Pinpoint account, including the identity's verification status, its DKIM authentication status, and its custom Mail-From settings.
1359 1360 1361 1362 |
# File 'gems/aws-sdk-pinpointemail/lib/aws-sdk-pinpointemail/client.rb', line 1359 def get_email_identity(params = {}, = {}) req = build_request(:get_email_identity, params) req.send_request() end |
#list_configuration_sets(params = {}) ⇒ Types::ListConfigurationSetsResponse
List all of the configuration sets associated with your Amazon Pinpoint account in the current region.
In Amazon Pinpoint, 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.
1407 1408 1409 1410 |
# File 'gems/aws-sdk-pinpointemail/lib/aws-sdk-pinpointemail/client.rb', line 1407 def list_configuration_sets(params = {}, = {}) req = build_request(:list_configuration_sets, params) req.send_request() end |
#list_dedicated_ip_pools(params = {}) ⇒ Types::ListDedicatedIpPoolsResponse
List all of the dedicated IP pools that exist in your Amazon Pinpoint account in the current AWS Region.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1449 1450 1451 1452 |
# File 'gems/aws-sdk-pinpointemail/lib/aws-sdk-pinpointemail/client.rb', line 1449 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.
1503 1504 1505 1506 |
# File 'gems/aws-sdk-pinpointemail/lib/aws-sdk-pinpointemail/client.rb', line 1503 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 (PutDeliverabilityDashboardOption
operation) for the
domain.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1580 1581 1582 1583 |
# File 'gems/aws-sdk-pinpointemail/lib/aws-sdk-pinpointemail/client.rb', line 1580 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 Pinpoint 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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1629 1630 1631 1632 |
# File 'gems/aws-sdk-pinpointemail/lib/aws-sdk-pinpointemail/client.rb', line 1629 def list_email_identities(params = {}, = {}) req = build_request(:list_email_identities, 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 in Amazon Pinpoint. 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.
1665 1666 1667 1668 |
# File 'gems/aws-sdk-pinpointemail/lib/aws-sdk-pinpointemail/client.rb', line 1665 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.
1691 1692 1693 1694 |
# File 'gems/aws-sdk-pinpointemail/lib/aws-sdk-pinpointemail/client.rb', line 1691 def put_account_dedicated_ip_warmup_attributes(params = {}, = {}) req = build_request(:put_account_dedicated_ip_warmup_attributes, params) req.send_request() end |
#put_account_sending_attributes(params = {}) ⇒ Struct
Enable or disable the ability of your account to send email.
1720 1721 1722 1723 |
# File 'gems/aws-sdk-pinpointemail/lib/aws-sdk-pinpointemail/client.rb', line 1720 def put_account_sending_attributes(params = {}, = {}) req = build_request(:put_account_sending_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.
1758 1759 1760 1761 |
# File 'gems/aws-sdk-pinpointemail/lib/aws-sdk-pinpointemail/client.rb', line 1758 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 AWS Region.
1788 1789 1790 1791 |
# File 'gems/aws-sdk-pinpointemail/lib/aws-sdk-pinpointemail/client.rb', line 1788 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 AWS Region.
1817 1818 1819 1820 |
# File 'gems/aws-sdk-pinpointemail/lib/aws-sdk-pinpointemail/client.rb', line 1817 def (params = {}, = {}) req = build_request(:put_configuration_set_sending_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 using Amazon Pinpoint.
1845 1846 1847 1848 |
# File 'gems/aws-sdk-pinpointemail/lib/aws-sdk-pinpointemail/client.rb', line 1845 def (params = {}, = {}) req = build_request(:put_configuration_set_tracking_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.
1882 1883 1884 1885 |
# File 'gems/aws-sdk-pinpointemail/lib/aws-sdk-pinpointemail/client.rb', line 1882 def put_dedicated_ip_in_pool(params = {}, = {}) req = build_request(:put_dedicated_ip_in_pool, params) req.send_request() end |
#put_dedicated_ip_warmup_attributes(params = {}) ⇒ Struct
Returns an empty response.
1908 1909 1910 1911 |
# File 'gems/aws-sdk-pinpointemail/lib/aws-sdk-pinpointemail/client.rb', line 1908 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 for your Amazon Pinpoint account. When you enable the Deliverability dashboard, you gain access to reputation, deliverability, and other metrics for the domains that you use to send email using Amazon Pinpoint. 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 Pinpoint. For more information about the features and cost of a Deliverability dashboard subscription, see Amazon Pinpoint Pricing.
1960 1961 1962 1963 |
# File 'gems/aws-sdk-pinpointemail/lib/aws-sdk-pinpointemail/client.rb', line 1960 def put_deliverability_dashboard_option(params = {}, = {}) req = build_request(:put_deliverability_dashboard_option, params) req.send_request() end |
#put_email_identity_dkim_attributes(params = {}) ⇒ Struct
Used to enable or disable DKIM authentication for an email identity.
1991 1992 1993 1994 |
# File 'gems/aws-sdk-pinpointemail/lib/aws-sdk-pinpointemail/client.rb', line 1991 def put_email_identity_dkim_attributes(params = {}, = {}) req = build_request(:put_email_identity_dkim_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.
When you enable feedback forwarding, Amazon Pinpoint sends you email notifications when bounce or complaint events occur. Amazon Pinpoint sends this notification to the address that you specified in the Return-Path header of the original email.
When you disable feedback forwarding, Amazon Pinpoint sends notifications through other mechanisms, such as by notifying an Amazon SNS topic. 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, Amazon Pinpoint sends an email notification when these events occur (even if this setting is disabled).
2046 2047 2048 2049 |
# File 'gems/aws-sdk-pinpointemail/lib/aws-sdk-pinpointemail/client.rb', line 2046 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.
2095 2096 2097 2098 |
# File 'gems/aws-sdk-pinpointemail/lib/aws-sdk-pinpointemail/client.rb', line 2095 def put_email_identity_mail_from_attributes(params = {}, = {}) req = build_request(:put_email_identity_mail_from_attributes, params) req.send_request() end |
#send_email(params = {}) ⇒ Types::SendEmailResponse
Sends an email message. You can use the Amazon Pinpoint Email API to send two 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 Pinpoint 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.
2199 2200 2201 2202 |
# File 'gems/aws-sdk-pinpointemail/lib/aws-sdk-pinpointemail/client.rb', line 2199 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 in Amazon Pinpoint. 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.
2243 2244 2245 2246 |
# File 'gems/aws-sdk-pinpointemail/lib/aws-sdk-pinpointemail/client.rb', line 2243 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Remove one or more tags (keys and values) from a specified resource.
2277 2278 2279 2280 |
# File 'gems/aws-sdk-pinpointemail/lib/aws-sdk-pinpointemail/client.rb', line 2277 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.
In Amazon Pinpoint, events include message sends, deliveries, opens, clicks, bounces, and complaints. Event destinations are places that you can send information about these events to. For example, you can send event data to Amazon SNS to receive notifications when you receive bounces or complaints, or you can use Amazon Kinesis Data Firehose to stream data to Amazon S3 for long-term storage.
2338 2339 2340 2341 |
# File 'gems/aws-sdk-pinpointemail/lib/aws-sdk-pinpointemail/client.rb', line 2338 def update_configuration_set_event_destination(params = {}, = {}) req = build_request(:update_configuration_set_event_destination, params) req.send_request() end |