Paws::SESv2 - Perl Interface to AWS Amazon Simple Email Service
use Paws; my $obj = Paws->service('SESv2'); my $res = $obj->Method( Arg1 => $val1, Arg2 => [ 'V1', 'V2' ], # if Arg3 is an object, the HashRef will be used as arguments to the constructor # of the arguments type Arg3 => { Att1 => 'Val1' }, # if Arg4 is an array of objects, the HashRefs will be passed as arguments to # the constructor of the arguments type Arg4 => [ { Att1 => 'Val1' }, { Att1 => 'Val2' } ], );
Amazon SES API v2
Welcome to the Amazon SES API v2 Reference. This guide provides information about the Amazon SES API v2, including supported operations, data types, parameters, and schemas.
Amazon SES (https://aws.amazon.com/pinpoint) is an AWS 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 also review the Amazon Simple Email Service Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/). The Amazon SES Developer Guide provides information and code samples that demonstrate how to use Amazon SES API v2 features programmatically.
The Amazon SES API v2 is available in several AWS Regions and it provides an endpoint for each of these Regions. For a list of all the Regions and endpoints where the API is currently available, see AWS Service Endpoints (https://docs.aws.amazon.com/general/latest/gr/rande.html#ses_region) in the Amazon Web Services General Reference. To learn more about AWS Regions, see Managing AWS Regions (https://docs.aws.amazon.com/general/latest/gr/rande-manage.html) in the Amazon Web Services General Reference.
In each Region, AWS maintains multiple Availability Zones. These Availability Zones are physically isolated from each other, but are united by private, low-latency, high-throughput, and highly redundant network connections. These Availability Zones enable us to provide very high levels of availability and redundancy, while also minimizing latency. To learn more about the number of Availability Zones that are available in each Region, see AWS Global Infrastructure (http://aws.amazon.com/about-aws/global-infrastructure/).
For the AWS API documentation, see https://docs.aws.amazon.com/ses/
Each argument is described in detail in: Paws::SESv2::CreateConfigurationSet
Returns: a Paws::SESv2::CreateConfigurationSetResponse instance
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.
Each argument is described in detail in: Paws::SESv2::CreateConfigurationSetEventDestination
Returns: a Paws::SESv2::CreateConfigurationSetEventDestinationResponse instance
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 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.
Each argument is described in detail in: Paws::SESv2::CreateDedicatedIpPool
Returns: a Paws::SESv2::CreateDedicatedIpPoolResponse instance
Create a new pool of dedicated IP addresses. A pool can include one or more dedicated IP addresses that are associated with your AWS 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.
Each argument is described in detail in: Paws::SESv2::CreateDeliverabilityTestReport
Returns: a Paws::SESv2::CreateDeliverabilityTestReportResponse instance
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.
GetDeliverabilityTestReport
Each argument is described in detail in: Paws::SESv2::CreateEmailIdentity
Returns: a Paws::SESv2::CreateEmailIdentityResponse instance
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 (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim.html).
DkimSigningAttributes
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 that you want to use for DKIM authentication) and a private key.
CreateEmailIdentity
Each argument is described in detail in: Paws::SESv2::DeleteConfigurationSet
Returns: a Paws::SESv2::DeleteConfigurationSetResponse instance
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.
Each argument is described in detail in: Paws::SESv2::DeleteConfigurationSetEventDestination
Returns: a Paws::SESv2::DeleteConfigurationSetEventDestinationResponse instance
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 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.
Each argument is described in detail in: Paws::SESv2::DeleteDedicatedIpPool
Returns: a Paws::SESv2::DeleteDedicatedIpPoolResponse instance
Delete a dedicated IP pool.
Each argument is described in detail in: Paws::SESv2::DeleteEmailIdentity
Returns: a Paws::SESv2::DeleteEmailIdentityResponse instance
Deletes an email identity. An identity can be either an email address or a domain name.
Each argument is described in detail in: Paws::SESv2::DeleteSuppressedDestination
Returns: a Paws::SESv2::DeleteSuppressedDestinationResponse instance
Removes an email address from the suppression list for your account.
Each argument is described in detail in: Paws::SESv2::GetAccount
Returns: a Paws::SESv2::GetAccountResponse instance
Obtain information about the email-sending status and capabilities of your Amazon SES account in the current AWS Region.
Each argument is described in detail in: Paws::SESv2::GetBlacklistReports
Returns: a Paws::SESv2::GetBlacklistReportsResponse instance
Retrieve a list of the blacklists that your dedicated IP addresses appear on.
Each argument is described in detail in: Paws::SESv2::GetConfigurationSet
Returns: a Paws::SESv2::GetConfigurationSetResponse instance
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.
Each argument is described in detail in: Paws::SESv2::GetConfigurationSetEventDestinations
Returns: a Paws::SESv2::GetConfigurationSetEventDestinationsResponse instance
Retrieve a list of event destinations that are associated with a configuration set.
Each argument is described in detail in: Paws::SESv2::GetDedicatedIp
Returns: a Paws::SESv2::GetDedicatedIpResponse instance
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.
Each argument is described in detail in: Paws::SESv2::GetDedicatedIps
Returns: a Paws::SESv2::GetDedicatedIpsResponse instance
List the dedicated IP addresses that are associated with your AWS account.
Each argument is described in detail in: Paws::SESv2::GetDeliverabilityDashboardOptions
Returns: a Paws::SESv2::GetDeliverabilityDashboardOptionsResponse instance
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 AWS services. For more information about the features and cost of a Deliverability dashboard subscription, see Amazon SES Pricing (http://aws.amazon.com/ses/pricing/).
Each argument is described in detail in: Paws::SESv2::GetDeliverabilityTestReport
Returns: a Paws::SESv2::GetDeliverabilityTestReportResponse instance
Retrieve the results of a predictive inbox placement test.
Each argument is described in detail in: Paws::SESv2::GetDomainDeliverabilityCampaign
Returns: a Paws::SESv2::GetDomainDeliverabilityCampaignResponse instance
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.
Each argument is described in detail in: Paws::SESv2::GetDomainStatisticsReport
Returns: a Paws::SESv2::GetDomainStatisticsReportResponse instance
Retrieve inbox placement and engagement rates for the domains that you use to send email.
Each argument is described in detail in: Paws::SESv2::GetEmailIdentity
Returns: a Paws::SESv2::GetEmailIdentityResponse instance
Provides information about a specific identity, including the identity's verification status, its DKIM authentication status, and its custom Mail-From settings.
Each argument is described in detail in: Paws::SESv2::GetSuppressedDestination
Returns: a Paws::SESv2::GetSuppressedDestinationResponse instance
Retrieves information about a specific email address that's on the suppression list for your account.
Each argument is described in detail in: Paws::SESv2::ListConfigurationSets
Returns: a Paws::SESv2::ListConfigurationSetsResponse instance
List all of the configuration sets associated with your account in the current region.
Each argument is described in detail in: Paws::SESv2::ListDedicatedIpPools
Returns: a Paws::SESv2::ListDedicatedIpPoolsResponse instance
List all of the dedicated IP pools that exist in your AWS account in the current Region.
Each argument is described in detail in: Paws::SESv2::ListDeliverabilityTestReports
Returns: a Paws::SESv2::ListDeliverabilityTestReportsResponse instance
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.
Each argument is described in detail in: Paws::SESv2::ListDomainDeliverabilityCampaigns
Returns: a Paws::SESv2::ListDomainDeliverabilityCampaignsResponse instance
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.
Each argument is described in detail in: Paws::SESv2::ListEmailIdentities
Returns: a Paws::SESv2::ListEmailIdentitiesResponse instance
Returns a list of all of the email identities that are associated with your AWS 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.
Each argument is described in detail in: Paws::SESv2::ListSuppressedDestinations
Returns: a Paws::SESv2::ListSuppressedDestinationsResponse instance
Retrieves a list of email addresses that are on the suppression list for your account.
Each argument is described in detail in: Paws::SESv2::ListTagsForResource
Returns: a Paws::SESv2::ListTagsForResourceResponse instance
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.
Each argument is described in detail in: Paws::SESv2::PutAccountDedicatedIpWarmupAttributes
Returns: a Paws::SESv2::PutAccountDedicatedIpWarmupAttributesResponse instance
Enable or disable the automatic warm-up feature for dedicated IP addresses.
Each argument is described in detail in: Paws::SESv2::PutAccountSendingAttributes
Returns: a Paws::SESv2::PutAccountSendingAttributesResponse instance
Enable or disable the ability of your account to send email.
Each argument is described in detail in: Paws::SESv2::PutAccountSuppressionAttributes
Returns: a Paws::SESv2::PutAccountSuppressionAttributesResponse instance
Change the settings for the account-level suppression list.
Each argument is described in detail in: Paws::SESv2::PutConfigurationSetDeliveryOptions
Returns: a Paws::SESv2::PutConfigurationSetDeliveryOptionsResponse instance
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.
Each argument is described in detail in: Paws::SESv2::PutConfigurationSetReputationOptions
Returns: a Paws::SESv2::PutConfigurationSetReputationOptionsResponse instance
Enable or disable collection of reputation metrics for emails that you send using a particular configuration set in a specific AWS Region.
Each argument is described in detail in: Paws::SESv2::PutConfigurationSetSendingOptions
Returns: a Paws::SESv2::PutConfigurationSetSendingOptionsResponse instance
Enable or disable email sending for messages that use a particular configuration set in a specific AWS Region.
Each argument is described in detail in: Paws::SESv2::PutConfigurationSetSuppressionOptions
Returns: a Paws::SESv2::PutConfigurationSetSuppressionOptionsResponse instance
Specify the account suppression list preferences for a configuration set.
Each argument is described in detail in: Paws::SESv2::PutConfigurationSetTrackingOptions
Returns: a Paws::SESv2::PutConfigurationSetTrackingOptionsResponse instance
Specify a custom domain to use for open and click tracking elements in email that you send.
Each argument is described in detail in: Paws::SESv2::PutDedicatedIpInPool
Returns: a Paws::SESv2::PutDedicatedIpInPoolResponse instance
Move a dedicated IP address to an existing dedicated IP pool.
The dedicated IP address that you specify must already exist, and must be associated with your AWS account.
The dedicated IP pool you specify must already exist. You can create a new pool by using the CreateDedicatedIpPool operation.
CreateDedicatedIpPool
Each argument is described in detail in: Paws::SESv2::PutDedicatedIpWarmupAttributes
Returns: a Paws::SESv2::PutDedicatedIpWarmupAttributesResponse instance
Each argument is described in detail in: Paws::SESv2::PutDeliverabilityDashboardOption
Returns: a Paws::SESv2::PutDeliverabilityDashboardOptionResponse instance
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.
Each argument is described in detail in: Paws::SESv2::PutEmailIdentityDkimAttributes
Returns: a Paws::SESv2::PutEmailIdentityDkimAttributesResponse instance
Used to enable or disable DKIM authentication for an email identity.
Each argument is described in detail in: Paws::SESv2::PutEmailIdentityDkimSigningAttributes
Returns: a Paws::SESv2::PutEmailIdentityDkimSigningAttributesResponse instance
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).
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.
Each argument is described in detail in: Paws::SESv2::PutEmailIdentityFeedbackAttributes
Returns: a Paws::SESv2::PutEmailIdentityFeedbackAttributesResponse instance
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.
true
Return-Path
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).
Each argument is described in detail in: Paws::SESv2::PutEmailIdentityMailFromAttributes
Returns: a Paws::SESv2::PutEmailIdentityMailFromAttributesResponse instance
Used to enable or disable the custom Mail-From domain configuration for an email identity.
Each argument is described in detail in: Paws::SESv2::PutSuppressedDestination
Returns: a Paws::SESv2::PutSuppressedDestinationResponse instance
Adds an email address to the suppression list for your account.
Each argument is described in detail in: Paws::SESv2::SendEmail
Returns: a Paws::SESv2::SendEmailResponse instance
Sends an email message. You can use the Amazon SES API v2 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 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.
Each argument is described in detail in: Paws::SESv2::TagResource
Returns: a Paws::SESv2::TagResourceResponse instance
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.
Each argument is described in detail in: Paws::SESv2::UntagResource
Returns: a Paws::SESv2::UntagResourceResponse instance
Remove one or more tags (keys and values) from a specified resource.
Each argument is described in detail in: Paws::SESv2::UpdateConfigurationSetEventDestination
Returns: a Paws::SESv2::UpdateConfigurationSetEventDestinationResponse instance
Update the configuration of an event destination for a configuration set.
Paginator methods are helpers that repetively call methods that return partial results
This service class forms part of Paws
The source code is located here: https://github.com/pplu/aws-sdk-perl
Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
To install Paws::SDK::Config, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Paws::SDK::Config
CPAN shell
perl -MCPAN -e shell install Paws::SDK::Config
For more information on module installation, please visit the detailed CPAN module installation guide.