sesv2 {paws}

Amazon Simple Email Service

Description

Amazon SES API v2

Amazon SES is an Amazon Web Services service that you can use to send email messages to your customers.

If you're new to Amazon SES API v2, you might find it helpful to review the Amazon Simple Email Service Developer Guide. The Amazon SES Developer Guide provides information and code samples that demonstrate how to use Amazon SES API v2 features programmatically.

Usage

sesv2(config = list(), credentials = list(), endpoint = NULL, region = NULL)

Arguments

config

Optional configuration of credentials, endpoint, and/or region.

• credentials:

  • creds:

    • access_key_id: AWS access key ID

    • secret_access_key: AWS secret access key

    • session_token: AWS temporary session token

  • profile: The name of a profile to use. If not given, then the default profile is used.

  • anonymous: Set anonymous credentials.

• endpoint: The complete URL to use for the constructed client.

• region: The AWS Region used in instantiating the client.

• close_connection: Immediately close all HTTP connections.

• timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.

• s3_force_path_style: Set this to true to force the request to use path-style addressing, i.e. ⁠http://s3.amazonaws.com/BUCKET/KEY⁠.

• sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html

credentials

Optional credentials shorthand for the config parameter

• creds:

  • access_key_id: AWS access key ID

  • secret_access_key: AWS secret access key

  • session_token: AWS temporary session token

• profile: The name of a profile to use. If not given, then the default profile is used.

• anonymous: Set anonymous credentials.

endpoint

Optional shorthand for complete URL to use for the constructed client.

region

Optional shorthand for AWS Region used in instantiating the client.

Value

A client for the service. You can call the service's operations using syntax like svc$operation(...), where svc is the name you've assigned to the client. The available operations are listed in the Operations section.

Service syntax

svc <- sesv2(
  config = list(
    credentials = list(
      creds = list(
        access_key_id = "string",
        secret_access_key = "string",
        session_token = "string"
      ),
      profile = "string",
      anonymous = "logical"
    ),
    endpoint = "string",
    region = "string",
    close_connection = "logical",
    timeout = "numeric",
    s3_force_path_style = "logical",
    sts_regional_endpoint = "string"
  ),
  credentials = list(
    creds = list(
      access_key_id = "string",
      secret_access_key = "string",
      session_token = "string"
    ),
    profile = "string",
    anonymous = "logical"
  ),
  endpoint = "string",
  region = "string"
)

Operations

batch_get_metric_data	Retrieves batches of metric data collected based on your sending activity
cancel_export_job	Cancels an export job
create_configuration_set	Create a configuration set
create_configuration_set_event_destination	Create an event destination
create_contact	Creates a contact, which is an end-user who is receiving the email, and adds them to a contact list
create_contact_list	Creates a contact list
create_custom_verification_email_template	Creates a new custom verification email template
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	Starts the process of verifying an email identity
create_email_identity_policy	Creates the specified sending authorization policy for the given identity (an email address or a domain)
create_email_template	Creates an email template
create_export_job	Creates an export job for a data source and destination
create_import_job	Creates an import job for a data destination
delete_configuration_set	Delete an existing configuration set
delete_configuration_set_event_destination	Delete an event destination
delete_contact	Removes a contact from a contact list
delete_contact_list	Deletes a contact list and all of the contacts on that list
delete_custom_verification_email_template	Deletes an existing custom verification email template
delete_dedicated_ip_pool	Delete a dedicated IP pool
delete_email_identity	Deletes an email identity
delete_email_identity_policy	Deletes the specified sending authorization policy for the given identity (an email address or a domain)
delete_email_template	Deletes an email template
delete_suppressed_destination	Removes an email address from the suppression list for your account
get_account	Obtain information about the email-sending status and capabilities of your Amazon SES account in the current Amazon Web Services 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_contact	Returns a contact from a contact list
get_contact_list	Returns contact list metadata
get_custom_verification_email_template	Returns the custom email verification template for the template name you specify
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_ip_pool	Retrieve information about the dedicated pool
get_dedicated_ips	List the dedicated IP addresses that are associated with your Amazon Web Services account
get_deliverability_dashboard_options	Retrieve information about the status of the Deliverability dashboard for your account
get_deliverability_test_report	Retrieve the results of a predictive inbox placement test
get_domain_deliverability_campaign	Retrieve all the deliverability data for a specific campaign
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, including the identity's verification status, sending authorization policies, its DKIM authentication status, and its custom Mail-From settings
get_email_identity_policies	Returns the requested sending authorization policies for the given identity (an email address or a domain)
get_email_template	Displays the template object (which includes the subject line, HTML part and text part) for the template you specify
get_export_job	Provides information about an export job
get_import_job	Provides information about an import job
get_message_insights	Provides information about a specific message, including the from address, the subject, the recipient address, email tags, as well as events associated with the message
get_suppressed_destination	Retrieves information about a specific email address that's on the suppression list for your account
list_configuration_sets	List all of the configuration sets associated with your account in the current region
list_contact_lists	Lists all of the contact lists available
list_contacts	Lists the contacts present in a specific contact list
list_custom_verification_email_templates	Lists the existing custom verification email templates for your account in the current Amazon Web Services Region
list_dedicated_ip_pools	List all of the dedicated IP pools that exist in your Amazon Web Services account in the current Region
list_deliverability_test_reports	Show a list of the predictive inbox placement tests that you've performed, regardless of their statuses
list_domain_deliverability_campaigns	Retrieve deliverability data for all the campaigns that used a specific domain to send email during a specified time range
list_email_identities	Returns a list of all of the email identities that are associated with your Amazon Web Services account
list_email_templates	Lists the email templates present in your Amazon SES account in the current Amazon Web Services Region
list_export_jobs	Lists all of the export jobs
list_import_jobs	Lists all of the import jobs
list_recommendations	Lists the recommendations present in your Amazon SES account in the current Amazon Web Services Region
list_suppressed_destinations	Retrieves a list of email addresses that are on the suppression list for your account
list_tags_for_resource	Retrieve a list of the tags (keys and values) that are associated with a specified resource
put_account_dedicated_ip_warmup_attributes	Enable or disable the automatic warm-up feature for dedicated IP addresses
put_account_details	Update your Amazon SES account details
put_account_sending_attributes	Enable or disable the ability of your account to send email
put_account_suppression_attributes	Change the settings for the account-level suppression list
put_account_vdm_attributes	Update your Amazon SES account VDM attributes
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 Amazon Web Services Region
put_configuration_set_sending_options	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	Specify the account suppression list preferences for a configuration set
put_configuration_set_tracking_options	Specify a custom domain to use for open and click tracking elements in email that you send
put_configuration_set_vdm_options	Specify VDM preferences for email that you send using the configuration set
put_dedicated_ip_in_pool	Move a dedicated IP address to an existing dedicated IP pool
put_dedicated_ip_pool_scaling_attributes	Used to convert a dedicated IP pool to a different scaling mode
put_dedicated_ip_warmup_attributes	Put dedicated ip warmup attributes
put_deliverability_dashboard_option	Enable or disable the Deliverability dashboard
put_email_identity_configuration_set_attributes	Used to associate a configuration set with an email identity
put_email_identity_dkim_attributes	Used to enable or disable DKIM authentication for an email identity
put_email_identity_dkim_signing_attributes	Used to configure or change the DKIM authentication settings for an email domain 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
put_suppressed_destination	Adds an email address to the suppression list for your account
send_bulk_email	Composes an email message to multiple destinations
send_custom_verification_email	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	Sends an email message
tag_resource	Add one or more tags (keys and values) to a specified resource
test_render_email_template	Creates a preview of the MIME content of an email when provided with a template and a set of replacement data
untag_resource	Remove one or more tags (keys and values) from a specified resource
update_configuration_set_event_destination	Update the configuration of an event destination for a configuration set
update_contact	Updates a contact's preferences for a list
update_contact_list	Updates contact list metadata
update_custom_verification_email_template	Updates an existing custom verification email template
update_email_identity_policy	Updates the specified sending authorization policy for the given identity (an email address or a domain)
update_email_template	Updates an email template

Examples

## Not run: 
svc <- sesv2()
# Cancels the export job with ID ef28cf62-9d8e-4b60-9283-b09816c99a99
svc$cancel_export_job(
  JobId = "ef28cf62-9d8e-4b60-9283-b09816c99a99"
)

## End(Not run)