NAME

Paws::PinpointEmail - Perl Interface to AWS Amazon Pinpoint Email Service

SYNOPSIS

  use Paws;

  my $obj = Paws->service('PinpointEmail');
  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' } ],
  );

DESCRIPTION

Amazon Pinpoint Email Service

Welcome to the Amazon Pinpoint Email API Reference. This guide provides information about the Amazon Pinpoint Email API (version 1.0), including supported operations, data types, parameters, and schemas.

Amazon Pinpoint (https://aws.amazon.com/pinpoint) is an AWS service that you can use to engage with your customers across multiple messaging channels. You can use Amazon Pinpoint to send email, SMS text messages, voice messages, and push notifications. The Amazon Pinpoint Email API provides programmatic access to options that are unique to the email channel and supplement the options provided by the Amazon Pinpoint API.

If you're new to Amazon Pinpoint, you might find it helpful to also review the Amazon Pinpoint Developer Guide (https://docs.aws.amazon.com/pinpoint/latest/developerguide/welcome.html). The Amazon Pinpoint Developer Guide provides tutorials, code samples, and procedures that demonstrate how to use Amazon Pinpoint features programmatically and how to integrate Amazon Pinpoint functionality into mobile apps and other types of applications. The guide also provides information about key topics such as Amazon Pinpoint integration with other AWS services and the limits that apply to using the service.

The Amazon Pinpoint Email API 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#pinpoint_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/

METHODS

CreateConfigurationSet

ConfigurationSetName => Str
[DeliveryOptions => Paws::PinpointEmail::DeliveryOptions]
[ReputationOptions => Paws::PinpointEmail::ReputationOptions]
[SendingOptions => Paws::PinpointEmail::SendingOptions]
[Tags => ArrayRef[Paws::PinpointEmail::Tag]]
[TrackingOptions => Paws::PinpointEmail::TrackingOptions]

Each argument is described in detail in: Paws::PinpointEmail::CreateConfigurationSet

Returns: a Paws::PinpointEmail::CreateConfigurationSetResponse instance

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.

CreateConfigurationSetEventDestination

ConfigurationSetName => Str
EventDestination => Paws::PinpointEmail::EventDestinationDefinition
EventDestinationName => Str

Each argument is described in detail in: Paws::PinpointEmail::CreateConfigurationSetEventDestination

Returns: a Paws::PinpointEmail::CreateConfigurationSetEventDestinationResponse instance

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.

CreateDedicatedIpPool

PoolName => Str
[Tags => ArrayRef[Paws::PinpointEmail::Tag]]

Each argument is described in detail in: Paws::PinpointEmail::CreateDedicatedIpPool

Returns: a Paws::PinpointEmail::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 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.

CreateDeliverabilityTestReport

Content => Paws::PinpointEmail::EmailContent
FromEmailAddress => Str
[ReportName => Str]
[Tags => ArrayRef[Paws::PinpointEmail::Tag]]

Each argument is described in detail in: Paws::PinpointEmail::CreateDeliverabilityTestReport

Returns: a Paws::PinpointEmail::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 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.

CreateEmailIdentity

EmailIdentity => Str
[Tags => ArrayRef[Paws::PinpointEmail::Tag]]

Each argument is described in detail in: Paws::PinpointEmail::CreateEmailIdentity

Returns: a Paws::PinpointEmail::CreateEmailIdentityResponse instance

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.

DeleteConfigurationSet

ConfigurationSetName => Str

Each argument is described in detail in: Paws::PinpointEmail::DeleteConfigurationSet

Returns: a Paws::PinpointEmail::DeleteConfigurationSetResponse instance

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.

DeleteConfigurationSetEventDestination

ConfigurationSetName => Str
EventDestinationName => Str

Each argument is described in detail in: Paws::PinpointEmail::DeleteConfigurationSetEventDestination

Returns: a Paws::PinpointEmail::DeleteConfigurationSetEventDestinationResponse instance

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.

DeleteDedicatedIpPool

PoolName => Str

Each argument is described in detail in: Paws::PinpointEmail::DeleteDedicatedIpPool

Returns: a Paws::PinpointEmail::DeleteDedicatedIpPoolResponse instance

Delete a dedicated IP pool.

DeleteEmailIdentity

EmailIdentity => Str

Each argument is described in detail in: Paws::PinpointEmail::DeleteEmailIdentity

Returns: a Paws::PinpointEmail::DeleteEmailIdentityResponse instance

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.

GetAccount

Each argument is described in detail in: Paws::PinpointEmail::GetAccount

Returns: a Paws::PinpointEmail::GetAccountResponse instance

Obtain information about the email-sending status and capabilities of your Amazon Pinpoint account in the current AWS Region.

GetBlacklistReports

BlacklistItemNames => ArrayRef[Str|Undef]

Each argument is described in detail in: Paws::PinpointEmail::GetBlacklistReports

Returns: a Paws::PinpointEmail::GetBlacklistReportsResponse instance

Retrieve a list of the blacklists that your dedicated IP addresses appear on.

GetConfigurationSet

ConfigurationSetName => Str

Each argument is described in detail in: Paws::PinpointEmail::GetConfigurationSet

Returns: a Paws::PinpointEmail::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.

GetConfigurationSetEventDestinations

ConfigurationSetName => Str

Each argument is described in detail in: Paws::PinpointEmail::GetConfigurationSetEventDestinations

Returns: a Paws::PinpointEmail::GetConfigurationSetEventDestinationsResponse instance

Retrieve a list of event destinations that are associated with a configuration set.

GetDedicatedIp

Ip => Str

Each argument is described in detail in: Paws::PinpointEmail::GetDedicatedIp

Returns: a Paws::PinpointEmail::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.

GetDedicatedIps

[NextToken => Str]
[PageSize => Int]
[PoolName => Str]

Each argument is described in detail in: Paws::PinpointEmail::GetDedicatedIps

Returns: a Paws::PinpointEmail::GetDedicatedIpsResponse instance

List the dedicated IP addresses that are associated with your Amazon Pinpoint account.

GetDeliverabilityDashboardOptions

Each argument is described in detail in: Paws::PinpointEmail::GetDeliverabilityDashboardOptions

Returns: a Paws::PinpointEmail::GetDeliverabilityDashboardOptionsResponse instance

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 (http://aws.amazon.com/pinpoint/pricing/).

GetDeliverabilityTestReport

ReportId => Str

Each argument is described in detail in: Paws::PinpointEmail::GetDeliverabilityTestReport

Returns: a Paws::PinpointEmail::GetDeliverabilityTestReportResponse instance

Retrieve the results of a predictive inbox placement test.

GetDomainDeliverabilityCampaign

CampaignId => Str

Each argument is described in detail in: Paws::PinpointEmail::GetDomainDeliverabilityCampaign

Returns: a Paws::PinpointEmail::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 (PutDeliverabilityDashboardOption operation).

GetDomainStatisticsReport

Domain => Str
EndDate => Str
StartDate => Str

Each argument is described in detail in: Paws::PinpointEmail::GetDomainStatisticsReport

Returns: a Paws::PinpointEmail::GetDomainStatisticsReportResponse instance

Retrieve inbox placement and engagement rates for the domains that you use to send email.

GetEmailIdentity

EmailIdentity => Str

Each argument is described in detail in: Paws::PinpointEmail::GetEmailIdentity

Returns: a Paws::PinpointEmail::GetEmailIdentityResponse instance

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.

ListConfigurationSets

[NextToken => Str]
[PageSize => Int]

Each argument is described in detail in: Paws::PinpointEmail::ListConfigurationSets

Returns: a Paws::PinpointEmail::ListConfigurationSetsResponse instance

List all of the configuration sets associated with your Amazon Pinpoint account in the current region.

ListDedicatedIpPools

[NextToken => Str]
[PageSize => Int]

Each argument is described in detail in: Paws::PinpointEmail::ListDedicatedIpPools

Returns: a Paws::PinpointEmail::ListDedicatedIpPoolsResponse instance

List all of the dedicated IP pools that exist in your Amazon Pinpoint account in the current AWS Region.

ListDeliverabilityTestReports

[NextToken => Str]
[PageSize => Int]

Each argument is described in detail in: Paws::PinpointEmail::ListDeliverabilityTestReports

Returns: a Paws::PinpointEmail::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.

ListDomainDeliverabilityCampaigns

EndDate => Str
StartDate => Str
SubscribedDomain => Str
[NextToken => Str]
[PageSize => Int]

Each argument is described in detail in: Paws::PinpointEmail::ListDomainDeliverabilityCampaigns

Returns: a Paws::PinpointEmail::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 (PutDeliverabilityDashboardOption operation) for the domain.

ListEmailIdentities

[NextToken => Str]
[PageSize => Int]

Each argument is described in detail in: Paws::PinpointEmail::ListEmailIdentities

Returns: a Paws::PinpointEmail::ListEmailIdentitiesResponse instance

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.

ListTagsForResource

ResourceArn => Str

Each argument is described in detail in: Paws::PinpointEmail::ListTagsForResource

Returns: a Paws::PinpointEmail::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 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.

PutAccountDedicatedIpWarmupAttributes

[AutoWarmupEnabled => Bool]

Each argument is described in detail in: Paws::PinpointEmail::PutAccountDedicatedIpWarmupAttributes

Returns: a Paws::PinpointEmail::PutAccountDedicatedIpWarmupAttributesResponse instance

Enable or disable the automatic warm-up feature for dedicated IP addresses.

PutAccountSendingAttributes

[SendingEnabled => Bool]

Each argument is described in detail in: Paws::PinpointEmail::PutAccountSendingAttributes

Returns: a Paws::PinpointEmail::PutAccountSendingAttributesResponse instance

Enable or disable the ability of your account to send email.

PutConfigurationSetDeliveryOptions

ConfigurationSetName => Str
[SendingPoolName => Str]
[TlsPolicy => Str]

Each argument is described in detail in: Paws::PinpointEmail::PutConfigurationSetDeliveryOptions

Returns: a Paws::PinpointEmail::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.

PutConfigurationSetReputationOptions

ConfigurationSetName => Str
[ReputationMetricsEnabled => Bool]

Each argument is described in detail in: Paws::PinpointEmail::PutConfigurationSetReputationOptions

Returns: a Paws::PinpointEmail::PutConfigurationSetReputationOptionsResponse instance

Enable or disable collection of reputation metrics for emails that you send using a particular configuration set in a specific AWS Region.

PutConfigurationSetSendingOptions

ConfigurationSetName => Str
[SendingEnabled => Bool]

Each argument is described in detail in: Paws::PinpointEmail::PutConfigurationSetSendingOptions

Returns: a Paws::PinpointEmail::PutConfigurationSetSendingOptionsResponse instance

Enable or disable email sending for messages that use a particular configuration set in a specific AWS Region.

PutConfigurationSetTrackingOptions

ConfigurationSetName => Str
[CustomRedirectDomain => Str]

Each argument is described in detail in: Paws::PinpointEmail::PutConfigurationSetTrackingOptions

Returns: a Paws::PinpointEmail::PutConfigurationSetTrackingOptionsResponse instance

Specify a custom domain to use for open and click tracking elements in email that you send using Amazon Pinpoint.

PutDedicatedIpInPool

DestinationPoolName => Str
Ip => Str

Each argument is described in detail in: Paws::PinpointEmail::PutDedicatedIpInPool

Returns: a Paws::PinpointEmail::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 Amazon Pinpoint account.

The dedicated IP pool you specify must already exist. You can create a new pool by using the CreateDedicatedIpPool operation.

PutDedicatedIpWarmupAttributes

Ip => Str
WarmupPercentage => Int

Each argument is described in detail in: Paws::PinpointEmail::PutDedicatedIpWarmupAttributes

Returns: a Paws::PinpointEmail::PutDedicatedIpWarmupAttributesResponse instance

PutDeliverabilityDashboardOption

DashboardEnabled => Bool
[SubscribedDomains => ArrayRef[Paws::PinpointEmail::DomainDeliverabilityTrackingOption]]

Each argument is described in detail in: Paws::PinpointEmail::PutDeliverabilityDashboardOption

Returns: a Paws::PinpointEmail::PutDeliverabilityDashboardOptionResponse instance

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.

PutEmailIdentityDkimAttributes

EmailIdentity => Str
[SigningEnabled => Bool]

Each argument is described in detail in: Paws::PinpointEmail::PutEmailIdentityDkimAttributes

Returns: a Paws::PinpointEmail::PutEmailIdentityDkimAttributesResponse instance

Used to enable or disable DKIM authentication for an email identity.

PutEmailIdentityFeedbackAttributes

EmailIdentity => Str
[EmailForwardingEnabled => Bool]

Each argument is described in detail in: Paws::PinpointEmail::PutEmailIdentityFeedbackAttributes

Returns: a Paws::PinpointEmail::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.

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).

PutEmailIdentityMailFromAttributes

EmailIdentity => Str
[BehaviorOnMxFailure => Str]
[MailFromDomain => Str]

Each argument is described in detail in: Paws::PinpointEmail::PutEmailIdentityMailFromAttributes

Returns: a Paws::PinpointEmail::PutEmailIdentityMailFromAttributesResponse instance

Used to enable or disable the custom Mail-From domain configuration for an email identity.

SendEmail

Content => Paws::PinpointEmail::EmailContent
Destination => Paws::PinpointEmail::Destination
[ConfigurationSetName => Str]
[EmailTags => ArrayRef[Paws::PinpointEmail::MessageTag]]
[FeedbackForwardingEmailAddress => Str]
[FromEmailAddress => Str]
[ReplyToAddresses => ArrayRef[Str|Undef]]

Each argument is described in detail in: Paws::PinpointEmail::SendEmail

Returns: a Paws::PinpointEmail::SendEmailResponse instance

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.

TagResource

ResourceArn => Str
Tags => ArrayRef[Paws::PinpointEmail::Tag]

Each argument is described in detail in: Paws::PinpointEmail::TagResource

Returns: a Paws::PinpointEmail::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 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.

UntagResource

ResourceArn => Str
TagKeys => ArrayRef[Str|Undef]

Each argument is described in detail in: Paws::PinpointEmail::UntagResource

Returns: a Paws::PinpointEmail::UntagResourceResponse instance

Remove one or more tags (keys and values) from a specified resource.

UpdateConfigurationSetEventDestination

ConfigurationSetName => Str
EventDestination => Paws::PinpointEmail::EventDestinationDefinition
EventDestinationName => Str

Each argument is described in detail in: Paws::PinpointEmail::UpdateConfigurationSetEventDestination

Returns: a Paws::PinpointEmail::UpdateConfigurationSetEventDestinationResponse instance

Update the configuration of an event destination for a configuration set.

PAGINATORS

Paginator methods are helpers that repetively call methods that return partial results