paws.customer.engagement (version 0.1.0)

pinpointemail: Amazon Pinpoint Email Service

Description

This document contains reference information for the Amazon Pinpoint Email API, version 1.0. This document is best used in conjunction with the Amazon Pinpoint Developer Guide.

The Amazon Pinpoint Email API is available in the US East (N. Virginia), US West (Oregon), EU (Frankfurt), and EU (Ireland) Regions at the following endpoints:

• US East (N. Virginia): email.us-east-1.amazonaws.com

• US West (Oregon): email.us-west-2.amazonaws.com

• EU (Frankfurt): email.eu-central-1.amazonaws.com

• EU (Ireland): email.eu-west-1.amazonaws.com

Usage

pinpointemail()

Operations

create_configuration_set	Create a configuration set
create_configuration_set_event_destination	Create an event destination
create_dedicated_ip_pool	Create a new pool of dedicated IP addresses
create_deliverability_test_report	Create a new predictive inbox placement test
create_email_identity	Verifies an email identity for use with Amazon Pinpoint
delete_configuration_set	Delete an existing configuration set
delete_configuration_set_event_destination	Delete an event destination
delete_dedicated_ip_pool	Delete a dedicated IP pool
delete_email_identity	Deletes an email identity that you previously verified for use with Amazon Pinpoint
get_account	Obtain information about the email-sending status and capabilities of your Amazon Pinpoint account in the current AWS Region
get_blacklist_reports	Retrieve a list of the blacklists that your dedicated IP addresses appear on
get_configuration_set	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	Retrieve a list of event destinations that are associated with a configuration set
get_dedicated_ip	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	List the dedicated IP addresses that are associated with your Amazon Pinpoint account
get_deliverability_dashboard_options	Show the status of the Deliverability dashboard
get_deliverability_test_report	Retrieve the results of a predictive inbox placement test
get_domain_statistics_report	Retrieve inbox placement and engagement rates for the domains that you use to send email
get_email_identity	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	List all of the configuration sets associated with your Amazon Pinpoint account in the current region
list_dedicated_ip_pools	List all of the dedicated IP pools that exist in your Amazon Pinpoint account in the current AWS Region
list_deliverability_test_reports	Show a list of the predictive inbox placement tests that you've performed, regardless of their statuses
list_email_identities	Returns a list of all of the email identities that are associated with your Amazon Pinpoint account
list_tags_for_resource	Retrieve a list of the tags (keys and values) that are associated with a specific resource
put_account_dedicated_ip_warmup_attributes	Enable or disable the automatic warm-up feature for dedicated IP addresses
put_account_sending_attributes	Enable or disable the ability of your account to send email
put_configuration_set_delivery_options	Associate a configuration set with a dedicated IP pool
put_configuration_set_reputation_options	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	Enable or disable email sending for messages that use a particular configuration set in a specific AWS Region
put_configuration_set_tracking_options	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	Move a dedicated IP address to an existing dedicated IP pool
put_dedicated_ip_warmup_attributes	Put dedicated ip warmup attributes
put_deliverability_dashboard_option	Enable or disable the Deliverability dashboard
put_email_identity_dkim_attributes	Used to enable or disable DKIM authentication for an email identity
put_email_identity_feedback_attributes	Used to enable or disable feedback forwarding for an identity
put_email_identity_mail_from_attributes	Used to enable or disable the custom Mail-From domain configuration for an email identity
send_email	Sends an email message
tag_resource	Add one or more tags (keys and values) to one or more specified resources
untag_resource	Remove one or more tags (keys and values) from a specified resource

Examples

# NOT RUN {
svc <- pinpointemail()
svc$create_configuration_set(
  Foo = 123
)
# }
# NOT RUN {
# }