Table of Contents
A low-level client representing Amazon Pinpoint Email Service:
import boto3
client = boto3.client('pinpoint-email')
These are the available methods:
Check if an operation can be paginated.
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.
See also: AWS API Documentation
Request Syntax
response = client.create_configuration_set(
ConfigurationSetName='string',
TrackingOptions={
'CustomRedirectDomain': 'string'
},
DeliveryOptions={
'SendingPoolName': 'string'
},
ReputationOptions={
'ReputationMetricsEnabled': True|False,
'LastFreshStart': datetime(2015, 1, 1)
},
SendingOptions={
'SendingEnabled': True|False
}
)
An object that defines the open and click tracking options for emails that you send using the configuration set.
The domain that you want to use for tracking open and click events.
An object that defines the dedicated IP pool that is used to send emails that you send using the configuration set.
The name of the dedicated IP pool that you want to associate with the configuration set.
An object that defines whether or not Amazon Pinpoint collects reputation metrics for the emails that you send that use the configuration set.
If true , tracking of reputation metrics is enabled for the configuration set. If false , tracking of reputation metrics is disabled for the configuration set.
The date and time (in Unix time) when the reputation metrics were last given a fresh start. When your account is given a fresh start, your reputation metrics are calculated starting from the date of the fresh start.
An object that defines whether or not Amazon Pinpoint can send email that you send using the configuration set.
If true , email sending is enabled for the configuration set. If false , email sending is disabled for the configuration set.
dict
Response Syntax
{}
Response Structure
(dict) --
An HTTP 200 response if the request succeeds, or an error message if the request fails.
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.
See also: AWS API Documentation
Request Syntax
response = client.create_configuration_set_event_destination(
ConfigurationSetName='string',
EventDestinationName='string',
EventDestination={
'Enabled': True|False,
'MatchingEventTypes': [
'SEND'|'REJECT'|'BOUNCE'|'COMPLAINT'|'DELIVERY'|'OPEN'|'CLICK'|'RENDERING_FAILURE',
],
'KinesisFirehoseDestination': {
'IamRoleArn': 'string',
'DeliveryStreamArn': 'string'
},
'CloudWatchDestination': {
'DimensionConfigurations': [
{
'DimensionName': 'string',
'DimensionValueSource': 'MESSAGE_TAG'|'EMAIL_HEADER'|'LINK_TAG',
'DefaultDimensionValue': 'string'
},
]
},
'SnsDestination': {
'TopicArn': 'string'
},
'PinpointDestination': {
'ApplicationArn': 'string'
}
}
)
[REQUIRED]
The name of the configuration set that you want to add an event destination to.
[REQUIRED]
A name that identifies the event destination within the configuration set.
[REQUIRED]
An object that defines the event destination.
If true , the event destination is enabled. When the event destination is enabled, the specified event types are sent to the destinations in this EventDestinationDefinition .
If false , the event destination is disabled. When the event destination is disabled, events aren't sent to the specified destinations.
An array that specifies which events Amazon Pinpoint should send to the destinations in this EventDestinationDefinition .
An email sending event type. For example, email sends, opens, and bounces are all email events.
An object that defines an Amazon Kinesis Data Firehose destination for email events. You can use Amazon Kinesis Data Firehose to stream data to other services, such as Amazon S3 and Amazon Redshift.
The Amazon Resource Name (ARN) of the IAM role that Amazon Pinpoint uses when sending email events to the Amazon Kinesis Data Firehose stream.
The Amazon Resource Name (ARN) of the Amazon Kinesis Data Firehose stream that Amazon Pinpoint sends email events to.
An object that defines an Amazon CloudWatch destination for email events. You can use Amazon CloudWatch to monitor and gain insights on your email sending metrics.
An array of objects that define the dimensions to use when you send email events to Amazon CloudWatch.
An object that defines the dimension configuration to use when you send Amazon Pinpoint email events to Amazon CloudWatch.
The name of an Amazon CloudWatch dimension associated with an email sending metric. The name has to meet the following criteria:
The location where Amazon Pinpoint finds the value of a dimension to publish to Amazon CloudWatch. If you want Amazon Pinpoint to use the message tags that you specify using an X-SES-MESSAGE-TAGS header or a parameter to the SendEmail/SendRawEmail API, choose messageTag . If you want Amazon Pinpoint to use your own email headers, choose emailHeader . If you want Amazon Pinpoint to use link tags, choose linkTags .
The default value of the dimension that is published to Amazon CloudWatch if you don't provide the value of the dimension when you send an email. This value has to meet the following criteria:
An object that defines an Amazon SNS destination for email events. You can use Amazon SNS to send notification when certain email events occur.
The Amazon Resource Name (ARN) of the Amazon SNS topic that you want to publish email events to. For more information about Amazon SNS topics, see the Amazon SNS Developer Guide .
An object that defines a Amazon Pinpoint destination for email events. You can use Amazon Pinpoint events to create attributes in Amazon Pinpoint projects. You can use these attributes to create segments for your campaigns.
The Amazon Resource Name (ARN) of the Amazon Pinpoint project that you want to send email events to.
dict
Response Syntax
{}
Response Structure
(dict) --
An HTTP 200 response if the request succeeds, or an error message if the request fails.
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.
See also: AWS API Documentation
Request Syntax
response = client.create_dedicated_ip_pool(
PoolName='string'
)
[REQUIRED]
The name of the dedicated IP pool.
{}
Response Structure
An HTTP 200 response if the request succeeds, or an error message if the request fails.
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.
See also: AWS API Documentation
Request Syntax
response = client.create_deliverability_test_report(
ReportName='string',
FromEmailAddress='string',
Content={
'Simple': {
'Subject': {
'Data': 'string',
'Charset': 'string'
},
'Body': {
'Text': {
'Data': 'string',
'Charset': 'string'
},
'Html': {
'Data': 'string',
'Charset': 'string'
}
}
},
'Raw': {
'Data': b'bytes'
}
}
)
[REQUIRED]
The email address that the predictive inbox placement test email was sent from.
[REQUIRED]
The HTML body of the message that you sent when you performed the predictive inbox placement test.
The simple email message. The message consists of a subject and a message body.
The subject line of the email. The subject line can only contain 7-bit ASCII characters. However, you can specify non-ASCII characters in the subject line by using encoded-word syntax, as described in RFC 2047 .
The content of the message itself.
The character set for the content. Because of the constraints of the SMTP protocol, Amazon Pinpoint uses 7-bit ASCII by default. If the text includes characters outside of the ASCII range, you have to specify a character set. For example, you could specify UTF-8 , ISO-8859-1 , or Shift_JIS .
The body of the message. You can specify an HTML version of the message, a text-only version of the message, or both.
An object that represents the version of the message that is displayed in email clients that don't support HTML, or clients where the recipient has disabled HTML rendering.
The content of the message itself.
The character set for the content. Because of the constraints of the SMTP protocol, Amazon Pinpoint uses 7-bit ASCII by default. If the text includes characters outside of the ASCII range, you have to specify a character set. For example, you could specify UTF-8 , ISO-8859-1 , or Shift_JIS .
An object that represents the version of the message that is displayed in email clients that support HTML. HTML messages can include formatted text, hyperlinks, images, and more.
The content of the message itself.
The character set for the content. Because of the constraints of the SMTP protocol, Amazon Pinpoint uses 7-bit ASCII by default. If the text includes characters outside of the ASCII range, you have to specify a character set. For example, you could specify UTF-8 , ISO-8859-1 , or Shift_JIS .
The raw email message. The message has to meet the following criteria:
The raw email message. The message has to meet the following criteria:
dict
Response Syntax
{
'ReportId': 'string',
'DeliverabilityTestStatus': 'IN_PROGRESS'|'COMPLETED'
}
Response Structure
(dict) --
Information about the predictive inbox placement test that you created.
ReportId (string) --
A unique string that identifies the predictive inbox placement test.
DeliverabilityTestStatus (string) --
The status of the predictive inbox placement test. If the status is IN_PROGRESS , then the predictive inbox placement test is currently running. Predictive inbox placement tests are usually complete within 24 hours of creating the test. If the status is COMPLETE , then the test is finished, and you can use the GetDeliverabilityTestReport to view the results of the test.
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.
See also: AWS API Documentation
Request Syntax
response = client.create_email_identity(
EmailIdentity='string'
)
[REQUIRED]
The email address or domain that you want to verify.
{
'IdentityType': 'EMAIL_ADDRESS'|'DOMAIN'|'MANAGED_DOMAIN',
'VerifiedForSendingStatus': True|False,
'DkimAttributes': {
'SigningEnabled': True|False,
'Status': 'PENDING'|'SUCCESS'|'FAILED'|'TEMPORARY_FAILURE'|'NOT_STARTED',
'Tokens': [
'string',
]
}
}
Response Structure
If the email identity is a domain, this object contains tokens that you can use to create a set of CNAME records. To sucessfully verify your domain, you have to add these records to the DNS configuration for your domain.
If the email identity is an email address, this object is empty.
The email identity type.
Specifies whether or not the identity is verified. In Amazon Pinpoint, you can only send email from verified email addresses or domains. For more information about verifying identities, see the Amazon Pinpoint User Guide .
An object that contains information about the DKIM attributes for the identity. This object includes the tokens that you use to create the CNAME records that are required to complete the DKIM verification process.
If the value is true , then the messages that Amazon Pinpoint sends from the identity are DKIM-signed. If the value is false , then the messages that Amazon Pinpoint sends from the identity aren't DKIM-signed.
Describes whether or not Amazon Pinpoint has successfully located the DKIM records in the DNS records for the domain. The status can be one of the following:
A set of unique strings that you use to create a set of CNAME records that you add to the DNS configuration for your domain. When Amazon Pinpoint detects these records in the DNS configuration for your domain, the DKIM authentication process is complete. Amazon Pinpoint usually detects these records within about 72 hours of adding them to the DNS configuration for your domain.
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.
See also: AWS API Documentation
Request Syntax
response = client.delete_configuration_set(
ConfigurationSetName='string'
)
[REQUIRED]
The name of the configuration set that you want to delete.
{}
Response Structure
An HTTP 200 response if the request succeeds, or an error message if the request fails.
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.
See also: AWS API Documentation
Request Syntax
response = client.delete_configuration_set_event_destination(
ConfigurationSetName='string',
EventDestinationName='string'
)
[REQUIRED]
The name of the configuration set that contains the event destination that you want to delete.
[REQUIRED]
The name of the event destination that you want to delete.
dict
Response Syntax
{}
Response Structure
(dict) --
An HTTP 200 response if the request succeeds, or an error message if the request fails.
Delete a dedicated IP pool.
See also: AWS API Documentation
Request Syntax
response = client.delete_dedicated_ip_pool(
PoolName='string'
)
[REQUIRED]
The name of the dedicated IP pool that you want to delete.
{}
Response Structure
An HTTP 200 response if the request succeeds, or an error message if the request fails.
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.
See also: AWS API Documentation
Request Syntax
response = client.delete_email_identity(
EmailIdentity='string'
)
[REQUIRED]
The identity (that is, the email address or domain) that you want to delete from your Amazon Pinpoint account.
{}
Response Structure
An HTTP 200 response if the request succeeds, or an error message if the request fails.
Generate a presigned url given a client, its method, and arguments
The presigned url
Obtain information about the email-sending status and capabilities of your Amazon Pinpoint account in the current AWS Region.
See also: AWS API Documentation
Request Syntax
response = client.get_account()
{
'SendQuota': {
'Max24HourSend': 123.0,
'MaxSendRate': 123.0,
'SentLast24Hours': 123.0
},
'SendingEnabled': True|False,
'DedicatedIpAutoWarmupEnabled': True|False,
'EnforcementStatus': 'string',
'ProductionAccessEnabled': True|False
}
Response Structure
A list of details about the email-sending capabilities of your Amazon Pinpoint account in the current AWS Region.
An object that contains information about the per-day and per-second sending limits for your Amazon Pinpoint account in the current AWS Region.
The maximum number of emails that you can send in the current AWS Region over a 24-hour period. This value is also called your sending quota .
The maximum number of emails that you can send per second in the current AWS Region. This value is also called your maximum sending rate or your maximum TPS (transactions per second) rate .
The number of emails sent from your Amazon Pinpoint account in the current AWS Region over the past 24 hours.
Indicates whether or not email sending is enabled for your Amazon Pinpoint account in the current AWS Region.
Indicates whether or not the automatic warm-up feature is enabled for dedicated IP addresses that are associated with your account.
The reputation status of your Amazon Pinpoint account. The status can be one of the following:
Indicates whether or not your account has production access in the current AWS Region.
If the value is false , then your account is in the sandbox . When your account is in the sandbox, you can only send email to verified identities. Additionally, the maximum number of emails you can send in a 24-hour period (your sending quota) is 200, and the maximum number of emails you can send per second (your maximum sending rate) is 1.
If the value is true , then your account has production access. When your account has production access, you can send email to any address. The sending quota and maximum sending rate for your account vary based on your specific use case.
Retrieve a list of the blacklists that your dedicated IP addresses appear on.
See also: AWS API Documentation
Request Syntax
response = client.get_blacklist_reports(
BlacklistItemNames=[
'string',
]
)
[REQUIRED]
A list of IP addresses that you want to retrieve blacklist information about. You can only specify the dedicated IP addresses that you use to send email using Amazon Pinpoint or Amazon SES.
An IP address that you want to obtain blacklist information for.
{
'BlacklistReport': {
'string': [
{
'RblName': 'string',
'ListingTime': datetime(2015, 1, 1),
'Description': 'string'
},
]
}
}
Response Structure
An object that contains information about blacklist events.
An object that contains information about a blacklist that one of your dedicated IP addresses appears on.
An IP address that you want to obtain blacklist information for.
An object that contains information about a blacklisting event that impacts one of the dedicated IP addresses that is associated with your account.
The name of the blacklist that the IP address appears on.
The time when the blacklisting event occurred, shown in Unix time format.
Additional information about the blacklisting event, as provided by the blacklist maintainer.
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.
See also: AWS API Documentation
Request Syntax
response = client.get_configuration_set(
ConfigurationSetName='string'
)
[REQUIRED]
The name of the configuration set that you want to obtain more information about.
{
'ConfigurationSetName': 'string',
'TrackingOptions': {
'CustomRedirectDomain': 'string'
},
'DeliveryOptions': {
'SendingPoolName': 'string'
},
'ReputationOptions': {
'ReputationMetricsEnabled': True|False,
'LastFreshStart': datetime(2015, 1, 1)
},
'SendingOptions': {
'SendingEnabled': True|False
}
}
Response Structure
Information about a configuration set.
The name of the configuration set.
An object that defines the open and click tracking options for emails that you send using the configuration set.
The domain that you want to use for tracking open and click events.
An object that defines the dedicated IP pool that is used to send emails that you send using the configuration set.
The name of the dedicated IP pool that you want to associate with the configuration set.
An object that defines whether or not Amazon Pinpoint collects reputation metrics for the emails that you send that use the configuration set.
If true , tracking of reputation metrics is enabled for the configuration set. If false , tracking of reputation metrics is disabled for the configuration set.
The date and time (in Unix time) when the reputation metrics were last given a fresh start. When your account is given a fresh start, your reputation metrics are calculated starting from the date of the fresh start.
An object that defines whether or not Amazon Pinpoint can send email that you send using the configuration set.
If true , email sending is enabled for the configuration set. If false , email sending is disabled for the configuration set.
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.
See also: AWS API Documentation
Request Syntax
response = client.get_configuration_set_event_destinations(
ConfigurationSetName='string'
)
[REQUIRED]
The name of the configuration set that contains the event destination.
{
'EventDestinations': [
{
'Name': 'string',
'Enabled': True|False,
'MatchingEventTypes': [
'SEND'|'REJECT'|'BOUNCE'|'COMPLAINT'|'DELIVERY'|'OPEN'|'CLICK'|'RENDERING_FAILURE',
],
'KinesisFirehoseDestination': {
'IamRoleArn': 'string',
'DeliveryStreamArn': 'string'
},
'CloudWatchDestination': {
'DimensionConfigurations': [
{
'DimensionName': 'string',
'DimensionValueSource': 'MESSAGE_TAG'|'EMAIL_HEADER'|'LINK_TAG',
'DefaultDimensionValue': 'string'
},
]
},
'SnsDestination': {
'TopicArn': 'string'
},
'PinpointDestination': {
'ApplicationArn': 'string'
}
},
]
}
Response Structure
Information about an event destination for a configuration set.
An array that includes all of the events destinations that have been configured for the 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.
A name that identifies the event destination.
If true , the event destination is enabled. When the event destination is enabled, the specified event types are sent to the destinations in this EventDestinationDefinition .
If false , the event destination is disabled. When the event destination is disabled, events aren't sent to the specified destinations.
The types of events that Amazon Pinpoint sends to the specified event destinations.
An email sending event type. For example, email sends, opens, and bounces are all email events.
An object that defines an Amazon Kinesis Data Firehose destination for email events. You can use Amazon Kinesis Data Firehose to stream data to other services, such as Amazon S3 and Amazon Redshift.
The Amazon Resource Name (ARN) of the IAM role that Amazon Pinpoint uses when sending email events to the Amazon Kinesis Data Firehose stream.
The Amazon Resource Name (ARN) of the Amazon Kinesis Data Firehose stream that Amazon Pinpoint sends email events to.
An object that defines an Amazon CloudWatch destination for email events. You can use Amazon CloudWatch to monitor and gain insights on your email sending metrics.
An array of objects that define the dimensions to use when you send email events to Amazon CloudWatch.
An object that defines the dimension configuration to use when you send Amazon Pinpoint email events to Amazon CloudWatch.
The name of an Amazon CloudWatch dimension associated with an email sending metric. The name has to meet the following criteria:
The location where Amazon Pinpoint finds the value of a dimension to publish to Amazon CloudWatch. If you want Amazon Pinpoint to use the message tags that you specify using an X-SES-MESSAGE-TAGS header or a parameter to the SendEmail/SendRawEmail API, choose messageTag . If you want Amazon Pinpoint to use your own email headers, choose emailHeader . If you want Amazon Pinpoint to use link tags, choose linkTags .
The default value of the dimension that is published to Amazon CloudWatch if you don't provide the value of the dimension when you send an email. This value has to meet the following criteria:
An object that defines an Amazon SNS destination for email events. You can use Amazon SNS to send notification when certain email events occur.
The Amazon Resource Name (ARN) of the Amazon SNS topic that you want to publish email events to. For more information about Amazon SNS topics, see the Amazon SNS Developer Guide .
An object that defines a Amazon Pinpoint destination for email events. You can use Amazon Pinpoint events to create attributes in Amazon Pinpoint projects. You can use these attributes to create segments for your campaigns.
The Amazon Resource Name (ARN) of the Amazon Pinpoint project that you want to send email events to.
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.
See also: AWS API Documentation
Request Syntax
response = client.get_dedicated_ip(
Ip='string'
)
[REQUIRED]
The IP address that you want to obtain more information about. The value you specify has to be a dedicated IP address that's assocaited with your Amazon Pinpoint account.
{
'DedicatedIp': {
'Ip': 'string',
'WarmupStatus': 'IN_PROGRESS'|'DONE',
'WarmupPercentage': 123,
'PoolName': 'string'
}
}
Response Structure
Information about a dedicated IP address.
An object that contains information about a dedicated IP address.
An IP address that is reserved for use by your Amazon Pinpoint account.
The warm-up status of a dedicated IP address. The status can have one of the following values:
Indicates how complete the dedicated IP warm-up process is. When this value equals 1, the address has completed the warm-up process and is ready for use.
The name of the dedicated IP pool that the IP address is associated with.
List the dedicated IP addresses that are associated with your Amazon Pinpoint account.
See also: AWS API Documentation
Request Syntax
response = client.get_dedicated_ips(
PoolName='string',
NextToken='string',
PageSize=123
)
dict
Response Syntax
{
'DedicatedIps': [
{
'Ip': 'string',
'WarmupStatus': 'IN_PROGRESS'|'DONE',
'WarmupPercentage': 123,
'PoolName': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Information about the dedicated IP addresses that are associated with your Amazon Pinpoint account.
DedicatedIps (list) --
A list of dedicated IP addresses that are reserved for use by your Amazon Pinpoint account.
(dict) --
Contains information about a dedicated IP address that is associated with your Amazon Pinpoint account.
Ip (string) --
An IP address that is reserved for use by your Amazon Pinpoint account.
WarmupStatus (string) --
The warm-up status of a dedicated IP address. The status can have one of the following values:
WarmupPercentage (integer) --
Indicates how complete the dedicated IP warm-up process is. When this value equals 1, the address has completed the warm-up process and is ready for use.
PoolName (string) --
The name of the dedicated IP pool that the IP address is associated with.
NextToken (string) --
A token that indicates that there are additional dedicated IP addresses to list. To view additional addresses, issue another request to GetDedicatedIps , passing this token in the NextToken parameter.
Show the status of the Deliverability dashboard. When the Deliverability dashboard is enabled, you gain access to reputation 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 charge of USD$1,250.00, in addition to any other fees that you accrue by using Amazon Pinpoint. If you enable the Deliverability dashboard after the first day of a calendar month, AWS prorates the monthly charge based on how many days have elapsed in the current calendar month.
See also: AWS API Documentation
Request Syntax
response = client.get_deliverability_dashboard_options()
{
'DashboardEnabled': True|False
}
Response Structure
An object that shows the status of the Deliverability dashboard for your Amazon Pinpoint account.
Indicates whether the Deliverability dashboard is enabled. If the value is true , then the dashboard is enabled.
Retrieve the results of a predictive inbox placement test.
See also: AWS API Documentation
Request Syntax
response = client.get_deliverability_test_report(
ReportId='string'
)
[REQUIRED]
A unique string that identifies the predictive inbox placement test.
{
'DeliverabilityTestReport': {
'ReportId': 'string',
'ReportName': 'string',
'Subject': 'string',
'FromEmailAddress': 'string',
'CreateDate': datetime(2015, 1, 1),
'DeliverabilityTestStatus': 'IN_PROGRESS'|'COMPLETED'
},
'OverallPlacement': {
'InboxPercentage': 123.0,
'SpamPercentage': 123.0,
'MissingPercentage': 123.0,
'SpfPercentage': 123.0,
'DkimPercentage': 123.0
},
'IspPlacements': [
{
'IspName': 'string',
'PlacementStatistics': {
'InboxPercentage': 123.0,
'SpamPercentage': 123.0,
'MissingPercentage': 123.0,
'SpfPercentage': 123.0,
'DkimPercentage': 123.0
}
},
],
'Message': 'string'
}
Response Structure
The results of the predictive inbox placement test.
An object that contains the results of the predictive inbox placement test.
A unique string that identifies the predictive inbox placement test.
A name that helps you identify a predictive inbox placement test report.
The subject line for an email that you submitted in a predictive inbox placement test.
The sender address that you specified for the predictive inbox placement test.
The date and time when the predictive inbox placement test was created, in Unix time format.
The status of the predictive inbox placement test. If the status is IN_PROGRESS , then the predictive inbox placement test is currently running. Predictive inbox placement tests are usually complete within 24 hours of creating the test. If the status is COMPLETE , then the test is finished, and you can use the GetDeliverabilityTestReport to view the results of the test.
An object that specifies how many test messages that were sent during the predictive inbox placement test were delivered to recipients' inboxes, how many were sent to recipients' spam folders, and how many weren't delivered.
The percentage of emails that arrived in recipients' inboxes during the predictive inbox placement test.
The percentage of emails that arrived in recipients' spam or junk mail folders during the predictive inbox placement test.
The percentage of emails that didn't arrive in recipients' inboxes at all during the predictive inbox placement test.
The percentage of emails that were authenticated by using Sender Policy Framework (SPF) during the predictive inbox placement test.
The percentage of emails that were authenticated by using DomainKeys Identified Mail (DKIM) during the predictive inbox placement test.
An object that describes how the test email was handled by several email providers, including Gmail, Hotmail, Yahoo, AOL, and others.
An object that describes how email sent during the predictive inbox placement test was handled by a certain email provider.
The name of the email provider that the inbox placement data applies to.
An object that contains inbox placement metrics for a specific email provider.
The percentage of emails that arrived in recipients' inboxes during the predictive inbox placement test.
The percentage of emails that arrived in recipients' spam or junk mail folders during the predictive inbox placement test.
The percentage of emails that didn't arrive in recipients' inboxes at all during the predictive inbox placement test.
The percentage of emails that were authenticated by using Sender Policy Framework (SPF) during the predictive inbox placement test.
The percentage of emails that were authenticated by using DomainKeys Identified Mail (DKIM) during the predictive inbox placement test.
An object that contains the message that you sent when you performed this predictive inbox placement test.
Retrieve inbox placement and engagement rates for the domains that you use to send email.
See also: AWS API Documentation
Request Syntax
response = client.get_domain_statistics_report(
Domain='string',
StartDate=datetime(2015, 1, 1),
EndDate=datetime(2015, 1, 1)
)
[REQUIRED]
The domain that you want to obtain deliverability metrics for.
[REQUIRED]
The first day (in Unix time) that you want to obtain domain deliverability metrics for.
[REQUIRED]
The last day (in Unix time) that you want to obtain domain deliverability metrics for. The EndDate that you specify has to be less than or equal to 30 days after the StartDate .
dict
Response Syntax
{
'OverallVolume': {
'VolumeStatistics': {
'InboxRawCount': 123,
'SpamRawCount': 123,
'ProjectedInbox': 123,
'ProjectedSpam': 123
},
'ReadRatePercent': 123.0,
'DomainIspPlacements': [
{
'IspName': 'string',
'InboxRawCount': 123,
'SpamRawCount': 123,
'InboxPercentage': 123.0,
'SpamPercentage': 123.0
},
]
},
'DailyVolumes': [
{
'StartDate': datetime(2015, 1, 1),
'VolumeStatistics': {
'InboxRawCount': 123,
'SpamRawCount': 123,
'ProjectedInbox': 123,
'ProjectedSpam': 123
},
'DomainIspPlacements': [
{
'IspName': 'string',
'InboxRawCount': 123,
'SpamRawCount': 123,
'InboxPercentage': 123.0,
'SpamPercentage': 123.0
},
]
},
]
}
Response Structure
(dict) --
An object that includes statistics that are related to the domain that you specified.
OverallVolume (dict) --
An object that contains deliverability metrics for the domain that you specified. The data in this object is a summary of all of the data that was collected from the StartDate to the EndDate .
VolumeStatistics (dict) --
An object that contains information about the numbers of messages that arrived in recipients' inboxes and junk mail folders.
InboxRawCount (integer) --
The total number of emails that arrived in recipients' inboxes.
SpamRawCount (integer) --
The total number of emails that arrived in recipients' spam or junk mail folders.
ProjectedInbox (integer) --
An estimate of the percentage of emails sent from the current domain that will arrive in recipients' inboxes.
ProjectedSpam (integer) --
An estimate of the percentage of emails sent from the current domain that will arrive in recipients' spam or junk mail folders.
ReadRatePercent (float) --
The percentage of emails that were sent from the domain that were read by their recipients.
DomainIspPlacements (list) --
An object that contains inbox and junk mail placement metrics for individual email providers.
(dict) --
An object that contains inbox placement data for email sent from one of your email domains to a specific email provider.
IspName (string) --
The name of the email provider that the inbox placement data applies to.
InboxRawCount (integer) --
The total number of messages that were sent from the selected domain to the specified email provider that arrived in recipients' inboxes.
SpamRawCount (integer) --
The total number of messages that were sent from the selected domain to the specified email provider that arrived in recipients' spam or junk mail folders.
InboxPercentage (float) --
The percentage of messages that were sent from the selected domain to the specified email provider that arrived in recipients' inboxes.
SpamPercentage (float) --
The percentage of messages that were sent from the selected domain to the specified email provider that arrived in recipients' spam or junk mail folders.
DailyVolumes (list) --
An object that contains deliverability metrics for the domain that you specified. This object contains data for each day, starting on the StartDate and ending on the EndDate .
(dict) --
An object that contains information about the volume of email sent on each day of the analysis period.
StartDate (datetime) --
The date that the DailyVolume metrics apply to, in Unix time.
VolumeStatistics (dict) --
An object that contains inbox placement metrics for a specific day in the analysis period.
InboxRawCount (integer) --
The total number of emails that arrived in recipients' inboxes.
SpamRawCount (integer) --
The total number of emails that arrived in recipients' spam or junk mail folders.
ProjectedInbox (integer) --
An estimate of the percentage of emails sent from the current domain that will arrive in recipients' inboxes.
ProjectedSpam (integer) --
An estimate of the percentage of emails sent from the current domain that will arrive in recipients' spam or junk mail folders.
DomainIspPlacements (list) --
An object that contains inbox placement metrics for a specifid day in the analysis period, broken out by the recipient's email provider.
(dict) --
An object that contains inbox placement data for email sent from one of your email domains to a specific email provider.
IspName (string) --
The name of the email provider that the inbox placement data applies to.
InboxRawCount (integer) --
The total number of messages that were sent from the selected domain to the specified email provider that arrived in recipients' inboxes.
SpamRawCount (integer) --
The total number of messages that were sent from the selected domain to the specified email provider that arrived in recipients' spam or junk mail folders.
InboxPercentage (float) --
The percentage of messages that were sent from the selected domain to the specified email provider that arrived in recipients' inboxes.
SpamPercentage (float) --
The percentage of messages that were sent from the selected domain to the specified email provider that arrived in recipients' spam or junk mail folders.
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.
See also: AWS API Documentation
Request Syntax
response = client.get_email_identity(
EmailIdentity='string'
)
[REQUIRED]
The email identity that you want to retrieve details for.
{
'IdentityType': 'EMAIL_ADDRESS'|'DOMAIN'|'MANAGED_DOMAIN',
'FeedbackForwardingStatus': True|False,
'VerifiedForSendingStatus': True|False,
'DkimAttributes': {
'SigningEnabled': True|False,
'Status': 'PENDING'|'SUCCESS'|'FAILED'|'TEMPORARY_FAILURE'|'NOT_STARTED',
'Tokens': [
'string',
]
},
'MailFromAttributes': {
'MailFromDomain': 'string',
'MailFromDomainStatus': 'PENDING'|'SUCCESS'|'FAILED'|'TEMPORARY_FAILURE',
'BehaviorOnMxFailure': 'USE_DEFAULT_VALUE'|'REJECT_MESSAGE'
}
}
Response Structure
Details about an email identity.
The email identity type.
The feedback forwarding configuration for the identity.
If the value is true , 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 set this value to false , Amazon Pinpoint sends notifications through other mechanisms, such as by notifying an Amazon SNS topic or another event destination. 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).
Specifies whether or not the identity is verified. In Amazon Pinpoint, you can only send email from verified email addresses or domains. For more information about verifying identities, see the Amazon Pinpoint User Guide .
An object that contains information about the DKIM attributes for the identity. This object includes the tokens that you use to create the CNAME records that are required to complete the DKIM verification process.
If the value is true , then the messages that Amazon Pinpoint sends from the identity are DKIM-signed. If the value is false , then the messages that Amazon Pinpoint sends from the identity aren't DKIM-signed.
Describes whether or not Amazon Pinpoint has successfully located the DKIM records in the DNS records for the domain. The status can be one of the following:
A set of unique strings that you use to create a set of CNAME records that you add to the DNS configuration for your domain. When Amazon Pinpoint detects these records in the DNS configuration for your domain, the DKIM authentication process is complete. Amazon Pinpoint usually detects these records within about 72 hours of adding them to the DNS configuration for your domain.
An object that contains information about the Mail-From attributes for the email identity.
The name of a domain that an email identity uses as a custom MAIL FROM domain.
The status of the MAIL FROM domain. This status can have the following values:
The action that Amazon Pinpoint to takes if it can't read the required MX record for a custom MAIL FROM domain. When you set this value to UseDefaultValue , Amazon Pinpoint uses amazonses.com as the MAIL FROM domain. When you set this value to RejectMessage , Amazon Pinpoint returns a MailFromDomainNotVerified error, and doesn't attempt to deliver the email.
These behaviors are taken when the custom MAIL FROM domain configuration is in the Pending , Failed , and TemporaryFailure states.
Create a paginator for an operation.
Returns an object that can wait for some condition.
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.
See also: AWS API Documentation
Request Syntax
response = client.list_configuration_sets(
NextToken='string',
PageSize=123
)
dict
Response Syntax
{
'ConfigurationSets': [
'string',
],
'NextToken': 'string'
}
Response Structure
(dict) --
A list of configuration sets in your Amazon Pinpoint account in the current AWS Region.
ConfigurationSets (list) --
An array that contains all of the configuration sets in your Amazon Pinpoint account in the current AWS Region.
(string) --
The name of a 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.
NextToken (string) --
A token that indicates that there are additional configuration sets to list. To view additional configuration sets, issue another request to ListConfigurationSets , and pass this token in the NextToken parameter.
List all of the dedicated IP pools that exist in your Amazon Pinpoint account in the current AWS Region.
See also: AWS API Documentation
Request Syntax
response = client.list_dedicated_ip_pools(
NextToken='string',
PageSize=123
)
dict
Response Syntax
{
'DedicatedIpPools': [
'string',
],
'NextToken': 'string'
}
Response Structure
(dict) --
A list of dedicated IP pools.
DedicatedIpPools (list) --
A list of all of the dedicated IP pools that are associated with your Amazon Pinpoint account.
(string) --
The name of a dedicated IP pool.
NextToken (string) --
A token that indicates that there are additional IP pools to list. To view additional IP pools, issue another request to ListDedicatedIpPools , passing this token in the NextToken parameter.
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.
See also: AWS API Documentation
Request Syntax
response = client.list_deliverability_test_reports(
NextToken='string',
PageSize=123
)
The number of results to show in a single call to ListDeliverabilityTestReports . If the number of results is larger than the number you specified in this parameter, then the response includes a NextToken element, which you can use to obtain additional results.
The value you specify has to be at least 0, and can be no more than 1000.
dict
Response Syntax
{
'DeliverabilityTestReports': [
{
'ReportId': 'string',
'ReportName': 'string',
'Subject': 'string',
'FromEmailAddress': 'string',
'CreateDate': datetime(2015, 1, 1),
'DeliverabilityTestStatus': 'IN_PROGRESS'|'COMPLETED'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
A list of the predictive inbox placement test reports that are available for your account, regardless of whether or not those tests are complete.
DeliverabilityTestReports (list) --
An object that contains a lists of predictive inbox placement tests that you've performed.
(dict) --
An object that contains metadata related to a predictive inbox placement test.
ReportId (string) --
A unique string that identifies the predictive inbox placement test.
ReportName (string) --
A name that helps you identify a predictive inbox placement test report.
Subject (string) --
The subject line for an email that you submitted in a predictive inbox placement test.
FromEmailAddress (string) --
The sender address that you specified for the predictive inbox placement test.
CreateDate (datetime) --
The date and time when the predictive inbox placement test was created, in Unix time format.
DeliverabilityTestStatus (string) --
The status of the predictive inbox placement test. If the status is IN_PROGRESS , then the predictive inbox placement test is currently running. Predictive inbox placement tests are usually complete within 24 hours of creating the test. If the status is COMPLETE , then the test is finished, and you can use the GetDeliverabilityTestReport to view the results of the test.
NextToken (string) --
A token that indicates that there are additional predictive inbox placement tests to list. To view additional predictive inbox placement tests, issue another request to ListDeliverabilityTestReports , and pass this token in the NextToken parameter.
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.
See also: AWS API Documentation
Request Syntax
response = client.list_email_identities(
NextToken='string',
PageSize=123
)
The number of results to show in a single call to ListEmailIdentities . If the number of results is larger than the number you specified in this parameter, then the response includes a NextToken element, which you can use to obtain additional results.
The value you specify has to be at least 0, and can be no more than 1000.
dict
Response Syntax
{
'EmailIdentities': [
{
'IdentityType': 'EMAIL_ADDRESS'|'DOMAIN'|'MANAGED_DOMAIN',
'IdentityName': 'string',
'SendingEnabled': True|False
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
A list of all of the identities that you've attempted to verify for use with Amazon Pinpoint, regardless of whether or not those identities were successfully verified.
EmailIdentities (list) --
An array that includes all of the identities associated with your Amazon Pinpoint account.
(dict) --
Information about an email identity.
IdentityType (string) --
The email identity type. The identity type can be one of the following:
IdentityName (string) --
The address or domain of the identity.
SendingEnabled (boolean) --
Indicates whether or not you can send email from the identity.
In Amazon Pinpoint, an identity is an email address or domain that you send email from. Before you can send email from an identity, you have to demostrate that you own the identity, and that you authorize Amazon Pinpoint to send email from that identity.
NextToken (string) --
A token that indicates that there are additional configuration sets to list. To view additional configuration sets, issue another request to ListEmailIdentities , and pass this token in the NextToken parameter.
Enable or disable the automatic warm-up feature for dedicated IP addresses.
See also: AWS API Documentation
Request Syntax
response = client.put_account_dedicated_ip_warmup_attributes(
AutoWarmupEnabled=True|False
)
{}
Response Structure
An HTTP 200 response if the request succeeds, or an error message if the request fails.
Enable or disable the ability of your account to send email.
See also: AWS API Documentation
Request Syntax
response = client.put_account_sending_attributes(
SendingEnabled=True|False
)
Enables or disables your account's ability to send email. Set to true to enable email sending, or set to false to disable email sending.
Note
If AWS paused your account's ability to send email, you can't use this operation to resume your account's ability to send email.
{}
Response Structure
An HTTP 200 response if the request succeeds, or an error message if the request fails.
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.
See also: AWS API Documentation
Request Syntax
response = client.put_configuration_set_delivery_options(
ConfigurationSetName='string',
SendingPoolName='string'
)
[REQUIRED]
The name of the configuration set that you want to associate with a dedicated IP pool.
dict
Response Syntax
{}
Response Structure
(dict) --
An HTTP 200 response if the request succeeds, or an error message if the request fails.
Enable or disable collection of reputation metrics for emails that you send using a particular configuration set in a specific AWS Region.
See also: AWS API Documentation
Request Syntax
response = client.put_configuration_set_reputation_options(
ConfigurationSetName='string',
ReputationMetricsEnabled=True|False
)
[REQUIRED]
The name of the configuration set that you want to enable or disable reputation metric tracking for.
dict
Response Syntax
{}
Response Structure
(dict) --
An HTTP 200 response if the request succeeds, or an error message if the request fails.
Enable or disable email sending for messages that use a particular configuration set in a specific AWS Region.
See also: AWS API Documentation
Request Syntax
response = client.put_configuration_set_sending_options(
ConfigurationSetName='string',
SendingEnabled=True|False
)
[REQUIRED]
The name of the configuration set that you want to enable or disable email sending for.
dict
Response Syntax
{}
Response Structure
(dict) --
An HTTP 200 response if the request succeeds, or an error message if the request fails.
Specify a custom domain to use for open and click tracking elements in email that you send using Amazon Pinpoint.
See also: AWS API Documentation
Request Syntax
response = client.put_configuration_set_tracking_options(
ConfigurationSetName='string',
CustomRedirectDomain='string'
)
[REQUIRED]
The name of the configuration set that you want to add a custom tracking domain to.
dict
Response Syntax
{}
Response Structure
(dict) --
An HTTP 200 response if the request succeeds, or an error message if the request fails.
Move a dedicated IP address to an existing dedicated IP pool.
Note
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.
See also: AWS API Documentation
Request Syntax
response = client.put_dedicated_ip_in_pool(
Ip='string',
DestinationPoolName='string'
)
[REQUIRED]
The IP address that you want to move to the dedicated IP pool. The value you specify has to be a dedicated IP address that's associated with your Amazon Pinpoint account.
[REQUIRED]
The name of the IP pool that you want to add the dedicated IP address to. You have to specify an IP pool that already exists.
dict
Response Syntax
{}
Response Structure
(dict) --
An HTTP 200 response if the request succeeds, or an error message if the request fails.
See also: AWS API Documentation
Request Syntax
response = client.put_dedicated_ip_warmup_attributes(
Ip='string',
WarmupPercentage=123
)
[REQUIRED]
The dedicated IP address that you want to update the warm-up attributes for.
[REQUIRED]
The warm-up percentage that you want to associate with the dedicated IP address.
dict
Response Syntax
{}
Response Structure
(dict) --
An HTTP 200 response if the request succeeds, or an error message if the request fails.
Enable or disable the Deliverability dashboard. When you enable the Deliverability dashboard, you gain access to reputation 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 charge of USD$1,250.00, in addition to any other fees that you accrue by using Amazon Pinpoint. If you enable the Deliverability dashboard after the first day of a calendar month, we prorate the monthly charge based on how many days have elapsed in the current calendar month.
See also: AWS API Documentation
Request Syntax
response = client.put_deliverability_dashboard_option(
DashboardEnabled=True|False
)
[REQUIRED]
Indicates whether the Deliverability dashboard is enabled. If the value is true , then the dashboard is enabled.
{}
Response Structure
A response that indicates whether the Deliverability dashboard is enabled for your Amazon Pinpoint account.
Used to enable or disable DKIM authentication for an email identity.
See also: AWS API Documentation
Request Syntax
response = client.put_email_identity_dkim_attributes(
EmailIdentity='string',
SigningEnabled=True|False
)
[REQUIRED]
The email identity that you want to change the DKIM settings for.
Sets the DKIM signing configuration for the identity.
When you set this value true , then the messages that Amazon Pinpoint sends from the identity are DKIM-signed. When you set this value to false , then the messages that Amazon Pinpoint sends from the identity aren't DKIM-signed.
dict
Response Syntax
{}
Response Structure
(dict) --
An HTTP 200 response if the request succeeds, or an error message if the request fails.
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).
See also: AWS API Documentation
Request Syntax
response = client.put_email_identity_feedback_attributes(
EmailIdentity='string',
EmailForwardingEnabled=True|False
)
[REQUIRED]
The email identity that you want to configure bounce and complaint feedback forwarding for.
Sets the feedback forwarding configuration for the identity.
If the value is true , 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 set this value to false , Amazon Pinpoint sends notifications through other mechanisms, such as by notifying an Amazon SNS topic or another event destination. 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).
dict
Response Syntax
{}
Response Structure
(dict) --
An HTTP 200 response if the request succeeds, or an error message if the request fails.
Used to enable or disable the custom Mail-From domain configuration for an email identity.
See also: AWS API Documentation
Request Syntax
response = client.put_email_identity_mail_from_attributes(
EmailIdentity='string',
MailFromDomain='string',
BehaviorOnMxFailure='USE_DEFAULT_VALUE'|'REJECT_MESSAGE'
)
[REQUIRED]
The verified email identity that you want to set up the custom MAIL FROM domain for.
The custom MAIL FROM domain that you want the verified identity to use. The MAIL FROM domain must meet the following criteria:
The action that you want Amazon Pinpoint to take if it can't read the required MX record when you send an email. When you set this value to UseDefaultValue , Amazon Pinpoint uses amazonses.com as the MAIL FROM domain. When you set this value to RejectMessage , Amazon Pinpoint returns a MailFromDomainNotVerified error, and doesn't attempt to deliver the email.
These behaviors are taken when the custom MAIL FROM domain configuration is in the Pending , Failed , and TemporaryFailure states.
dict
Response Syntax
{}
Response Structure
(dict) --
An HTTP 200 response if the request succeeds, or an error message if the request fails.
Sends an email message. You can use the Amazon Pinpoint Email API to send two types of messages:
See also: AWS API Documentation
Request Syntax
response = client.send_email(
FromEmailAddress='string',
Destination={
'ToAddresses': [
'string',
],
'CcAddresses': [
'string',
],
'BccAddresses': [
'string',
]
},
ReplyToAddresses=[
'string',
],
FeedbackForwardingEmailAddress='string',
Content={
'Simple': {
'Subject': {
'Data': 'string',
'Charset': 'string'
},
'Body': {
'Text': {
'Data': 'string',
'Charset': 'string'
},
'Html': {
'Data': 'string',
'Charset': 'string'
}
}
},
'Raw': {
'Data': b'bytes'
}
},
EmailTags=[
{
'Name': 'string',
'Value': 'string'
},
],
ConfigurationSetName='string'
)
[REQUIRED]
An object that contains the recipients of the email message.
An array that contains the email addresses of the "To" recipients for the email.
An array that contains the email addresses of the "CC" (carbon copy) recipients for the email.
An array that contains the email addresses of the "BCC" (blind carbon copy) recipients for the email.
The "Reply-to" email addresses for the message. When the recipient replies to the message, each Reply-to address receives the reply.
[REQUIRED]
An object that contains the body of the message. You can send either a Simple message or a Raw message.
The simple email message. The message consists of a subject and a message body.
The subject line of the email. The subject line can only contain 7-bit ASCII characters. However, you can specify non-ASCII characters in the subject line by using encoded-word syntax, as described in RFC 2047 .
The content of the message itself.
The character set for the content. Because of the constraints of the SMTP protocol, Amazon Pinpoint uses 7-bit ASCII by default. If the text includes characters outside of the ASCII range, you have to specify a character set. For example, you could specify UTF-8 , ISO-8859-1 , or Shift_JIS .
The body of the message. You can specify an HTML version of the message, a text-only version of the message, or both.
An object that represents the version of the message that is displayed in email clients that don't support HTML, or clients where the recipient has disabled HTML rendering.
The content of the message itself.
The character set for the content. Because of the constraints of the SMTP protocol, Amazon Pinpoint uses 7-bit ASCII by default. If the text includes characters outside of the ASCII range, you have to specify a character set. For example, you could specify UTF-8 , ISO-8859-1 , or Shift_JIS .
An object that represents the version of the message that is displayed in email clients that support HTML. HTML messages can include formatted text, hyperlinks, images, and more.
The content of the message itself.
The character set for the content. Because of the constraints of the SMTP protocol, Amazon Pinpoint uses 7-bit ASCII by default. If the text includes characters outside of the ASCII range, you have to specify a character set. For example, you could specify UTF-8 , ISO-8859-1 , or Shift_JIS .
The raw email message. The message has to meet the following criteria:
The raw email message. The message has to meet the following criteria:
A list of tags, in the form of name/value pairs, to apply to an email that you send using the SendEmail operation. Tags correspond to characteristics of the email that you define, so that you can publish email sending events.
Contains the name and value of a tag that you apply to an email. You can use message tags when you publish email sending events.
The name of the message tag. The message tag name has to meet the following criteria:
The value of the message tag. The message tag value has to meet the following criteria:
dict
Response Syntax
{
'MessageId': 'string'
}
Response Structure
(dict) --
A unique message ID that you receive when Amazon Pinpoint accepts an email for sending.
MessageId (string) --
A unique identifier for the message that is generated when Amazon Pinpoint accepts the message.
Note
It is possible for Amazon Pinpoint to accept a message without sending it. This can happen when the message you're trying to send has an attachment doesn't pass a virus check, or when you send a templated email that contains invalid personalization content, for example.
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.
See also: AWS API Documentation
Request Syntax
response = client.update_configuration_set_event_destination(
ConfigurationSetName='string',
EventDestinationName='string',
EventDestination={
'Enabled': True|False,
'MatchingEventTypes': [
'SEND'|'REJECT'|'BOUNCE'|'COMPLAINT'|'DELIVERY'|'OPEN'|'CLICK'|'RENDERING_FAILURE',
],
'KinesisFirehoseDestination': {
'IamRoleArn': 'string',
'DeliveryStreamArn': 'string'
},
'CloudWatchDestination': {
'DimensionConfigurations': [
{
'DimensionName': 'string',
'DimensionValueSource': 'MESSAGE_TAG'|'EMAIL_HEADER'|'LINK_TAG',
'DefaultDimensionValue': 'string'
},
]
},
'SnsDestination': {
'TopicArn': 'string'
},
'PinpointDestination': {
'ApplicationArn': 'string'
}
}
)
[REQUIRED]
The name of the configuration set that contains the event destination that you want to modify.
[REQUIRED]
The name of the event destination that you want to modify.
[REQUIRED]
An object that defines the event destination.
If true , the event destination is enabled. When the event destination is enabled, the specified event types are sent to the destinations in this EventDestinationDefinition .
If false , the event destination is disabled. When the event destination is disabled, events aren't sent to the specified destinations.
An array that specifies which events Amazon Pinpoint should send to the destinations in this EventDestinationDefinition .
An email sending event type. For example, email sends, opens, and bounces are all email events.
An object that defines an Amazon Kinesis Data Firehose destination for email events. You can use Amazon Kinesis Data Firehose to stream data to other services, such as Amazon S3 and Amazon Redshift.
The Amazon Resource Name (ARN) of the IAM role that Amazon Pinpoint uses when sending email events to the Amazon Kinesis Data Firehose stream.
The Amazon Resource Name (ARN) of the Amazon Kinesis Data Firehose stream that Amazon Pinpoint sends email events to.
An object that defines an Amazon CloudWatch destination for email events. You can use Amazon CloudWatch to monitor and gain insights on your email sending metrics.
An array of objects that define the dimensions to use when you send email events to Amazon CloudWatch.
An object that defines the dimension configuration to use when you send Amazon Pinpoint email events to Amazon CloudWatch.
The name of an Amazon CloudWatch dimension associated with an email sending metric. The name has to meet the following criteria:
The location where Amazon Pinpoint finds the value of a dimension to publish to Amazon CloudWatch. If you want Amazon Pinpoint to use the message tags that you specify using an X-SES-MESSAGE-TAGS header or a parameter to the SendEmail/SendRawEmail API, choose messageTag . If you want Amazon Pinpoint to use your own email headers, choose emailHeader . If you want Amazon Pinpoint to use link tags, choose linkTags .
The default value of the dimension that is published to Amazon CloudWatch if you don't provide the value of the dimension when you send an email. This value has to meet the following criteria:
An object that defines an Amazon SNS destination for email events. You can use Amazon SNS to send notification when certain email events occur.
The Amazon Resource Name (ARN) of the Amazon SNS topic that you want to publish email events to. For more information about Amazon SNS topics, see the Amazon SNS Developer Guide .
An object that defines a Amazon Pinpoint destination for email events. You can use Amazon Pinpoint events to create attributes in Amazon Pinpoint projects. You can use these attributes to create segments for your campaigns.
The Amazon Resource Name (ARN) of the Amazon Pinpoint project that you want to send email events to.
dict
Response Syntax
{}
Response Structure
(dict) --
An HTTP 200 response if the request succeeds, or an error message if the request fails.
The available paginators are:
paginator = client.get_paginator('get_dedicated_ips')
Creates an iterator that will paginate through responses from PinpointEmail.Client.get_dedicated_ips().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
PoolName='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'DedicatedIps': [
{
'Ip': 'string',
'WarmupStatus': 'IN_PROGRESS'|'DONE',
'WarmupPercentage': 123,
'PoolName': 'string'
},
],
}
Response Structure
(dict) --
Information about the dedicated IP addresses that are associated with your Amazon Pinpoint account.
DedicatedIps (list) --
A list of dedicated IP addresses that are reserved for use by your Amazon Pinpoint account.
(dict) --
Contains information about a dedicated IP address that is associated with your Amazon Pinpoint account.
Ip (string) --
An IP address that is reserved for use by your Amazon Pinpoint account.
WarmupStatus (string) --
The warm-up status of a dedicated IP address. The status can have one of the following values:
WarmupPercentage (integer) --
Indicates how complete the dedicated IP warm-up process is. When this value equals 1, the address has completed the warm-up process and is ready for use.
PoolName (string) --
The name of the dedicated IP pool that the IP address is associated with.
paginator = client.get_paginator('list_configuration_sets')
Creates an iterator that will paginate through responses from PinpointEmail.Client.list_configuration_sets().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
{
'ConfigurationSets': [
'string',
],
}
Response Structure
A list of configuration sets in your Amazon Pinpoint account in the current AWS Region.
An array that contains all of the configuration sets in your Amazon Pinpoint account in the current AWS Region.
The name of a 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.
paginator = client.get_paginator('list_dedicated_ip_pools')
Creates an iterator that will paginate through responses from PinpointEmail.Client.list_dedicated_ip_pools().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
{
'DedicatedIpPools': [
'string',
],
}
Response Structure
A list of dedicated IP pools.
A list of all of the dedicated IP pools that are associated with your Amazon Pinpoint account.
The name of a dedicated IP pool.
paginator = client.get_paginator('list_deliverability_test_reports')
Creates an iterator that will paginate through responses from PinpointEmail.Client.list_deliverability_test_reports().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
{
'DeliverabilityTestReports': [
{
'ReportId': 'string',
'ReportName': 'string',
'Subject': 'string',
'FromEmailAddress': 'string',
'CreateDate': datetime(2015, 1, 1),
'DeliverabilityTestStatus': 'IN_PROGRESS'|'COMPLETED'
},
],
}
Response Structure
A list of the predictive inbox placement test reports that are available for your account, regardless of whether or not those tests are complete.
An object that contains a lists of predictive inbox placement tests that you've performed.
An object that contains metadata related to a predictive inbox placement test.
A unique string that identifies the predictive inbox placement test.
A name that helps you identify a predictive inbox placement test report.
The subject line for an email that you submitted in a predictive inbox placement test.
The sender address that you specified for the predictive inbox placement test.
The date and time when the predictive inbox placement test was created, in Unix time format.
The status of the predictive inbox placement test. If the status is IN_PROGRESS , then the predictive inbox placement test is currently running. Predictive inbox placement tests are usually complete within 24 hours of creating the test. If the status is COMPLETE , then the test is finished, and you can use the GetDeliverabilityTestReport to view the results of the test.
paginator = client.get_paginator('list_email_identities')
Creates an iterator that will paginate through responses from PinpointEmail.Client.list_email_identities().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
{
'EmailIdentities': [
{
'IdentityType': 'EMAIL_ADDRESS'|'DOMAIN'|'MANAGED_DOMAIN',
'IdentityName': 'string',
'SendingEnabled': True|False
},
],
}
Response Structure
A list of all of the identities that you've attempted to verify for use with Amazon Pinpoint, regardless of whether or not those identities were successfully verified.
An array that includes all of the identities associated with your Amazon Pinpoint account.
Information about an email identity.
The email identity type. The identity type can be one of the following:
The address or domain of the identity.
Indicates whether or not you can send email from the identity.
In Amazon Pinpoint, an identity is an email address or domain that you send email from. Before you can send email from an identity, you have to demostrate that you own the identity, and that you authorize Amazon Pinpoint to send email from that identity.