2019/05/28 - Amazon Pinpoint Email Service - 2 new 5 updated api methods
Changes This release adds support for programmatic access to Deliverability dashboard subscriptions and the deliverability data provided by the Deliverability dashboard for domains and IP addresses. The data includes placement metrics for campaigns that use subscribed domains to send email.
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).
See also: AWS API Documentation
Request Syntax
client.get_domain_deliverability_campaign(
CampaignId='string'
)
string
[REQUIRED]
The unique identifier for the campaign. Amazon Pinpoint automatically generates and assigns this identifier to a campaign. This value is not the same as the campaign identifier that Amazon Pinpoint assigns to campaigns that you create and manage by using the Amazon Pinpoint API or the Amazon Pinpoint console.
dict
Response Syntax
{
'DomainDeliverabilityCampaign': {
'CampaignId': 'string',
'ImageUrl': 'string',
'Subject': 'string',
'FromAddress': 'string',
'SendingIps': [
'string',
],
'FirstSeenDateTime': datetime(2015, 1, 1),
'LastSeenDateTime': datetime(2015, 1, 1),
'InboxCount': 123,
'SpamCount': 123,
'ReadRate': 123.0,
'DeleteRate': 123.0,
'ReadDeleteRate': 123.0,
'ProjectedVolume': 123,
'Esps': [
'string',
]
}
}
Response Structure
(dict) --
An object that contains 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).
DomainDeliverabilityCampaign (dict) --
An object that contains the deliverability data for the campaign.
CampaignId (string) --
The unique identifier for the campaign. Amazon Pinpoint automatically generates and assigns this identifier to a campaign. This value is not the same as the campaign identifier that Amazon Pinpoint assigns to campaigns that you create and manage by using the Amazon Pinpoint API or the Amazon Pinpoint console.
ImageUrl (string) --
The URL of an image that contains a snapshot of the email message that was sent.
Subject (string) --
The subject line, or title, of the email message.
FromAddress (string) --
The verified email address that the email message was sent from.
SendingIps (list) --
The IP addresses that were used to send the email message.
(string) --
A dedicated IP address that is associated with your Amazon Pinpoint account.
FirstSeenDateTime (datetime) --
The first time, in Unix time format, when the email message was delivered to any recipient's inbox. This value can help you determine how long it took for a campaign to deliver an email message.
LastSeenDateTime (datetime) --
The last time, in Unix time format, when the email message was delivered to any recipient's inbox. This value can help you determine how long it took for a campaign to deliver an email message.
InboxCount (integer) --
The number of email messages that were delivered to recipients’ inboxes.
SpamCount (integer) --
The number of email messages that were delivered to recipients' spam or junk mail folders.
ReadRate (float) --
The percentage of email messages that were opened by recipients. Due to technical limitations, this value only includes recipients who opened the message by using an email client that supports images.
DeleteRate (float) --
The percentage of email messages that were deleted by recipients, without being opened first. Due to technical limitations, this value only includes recipients who opened the message by using an email client that supports images.
ReadDeleteRate (float) --
The percentage of email messages that were opened and then deleted by recipients. Due to technical limitations, this value only includes recipients who opened the message by using an email client that supports images.
ProjectedVolume (integer) --
The projected number of recipients that the email message was sent to.
Esps (list) --
The major email providers who handled the email message.
(string) --
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.
See also: AWS API Documentation
Request Syntax
client.list_domain_deliverability_campaigns(
StartDate=datetime(2015, 1, 1),
EndDate=datetime(2015, 1, 1),
SubscribedDomain='string',
NextToken='string',
PageSize=123
)
datetime
[REQUIRED]
The first day, in Unix time format, that you want to obtain deliverability data for.
datetime
[REQUIRED]
The last day, in Unix time format, that you want to obtain deliverability data for. This value has to be less than or equal to 30 days after the value of the StartDate parameter.
string
[REQUIRED]
The domain to obtain deliverability data for.
string
A token that’s returned from a previous call to the ListDomainDeliverabilityCampaigns operation. This token indicates the position of a campaign in the list of campaigns.
integer
The maximum number of results to include in response to a single call to the ListDomainDeliverabilityCampaigns operation. If the number of results is larger than the number that you specify in this parameter, the response includes a NextToken element, which you can use to obtain additional results.
dict
Response Syntax
{
'DomainDeliverabilityCampaigns': [
{
'CampaignId': 'string',
'ImageUrl': 'string',
'Subject': 'string',
'FromAddress': 'string',
'SendingIps': [
'string',
],
'FirstSeenDateTime': datetime(2015, 1, 1),
'LastSeenDateTime': datetime(2015, 1, 1),
'InboxCount': 123,
'SpamCount': 123,
'ReadRate': 123.0,
'DeleteRate': 123.0,
'ReadDeleteRate': 123.0,
'ProjectedVolume': 123,
'Esps': [
'string',
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
An array of objects that provide 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.
DomainDeliverabilityCampaigns (list) --
An array of responses, one for each campaign that used the domain to send email during the specified time range.
(dict) --
An object that contains 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).
CampaignId (string) --
The unique identifier for the campaign. Amazon Pinpoint automatically generates and assigns this identifier to a campaign. This value is not the same as the campaign identifier that Amazon Pinpoint assigns to campaigns that you create and manage by using the Amazon Pinpoint API or the Amazon Pinpoint console.
ImageUrl (string) --
The URL of an image that contains a snapshot of the email message that was sent.
Subject (string) --
The subject line, or title, of the email message.
FromAddress (string) --
The verified email address that the email message was sent from.
SendingIps (list) --
The IP addresses that were used to send the email message.
(string) --
A dedicated IP address that is associated with your Amazon Pinpoint account.
FirstSeenDateTime (datetime) --
The first time, in Unix time format, when the email message was delivered to any recipient's inbox. This value can help you determine how long it took for a campaign to deliver an email message.
LastSeenDateTime (datetime) --
The last time, in Unix time format, when the email message was delivered to any recipient's inbox. This value can help you determine how long it took for a campaign to deliver an email message.
InboxCount (integer) --
The number of email messages that were delivered to recipients’ inboxes.
SpamCount (integer) --
The number of email messages that were delivered to recipients' spam or junk mail folders.
ReadRate (float) --
The percentage of email messages that were opened by recipients. Due to technical limitations, this value only includes recipients who opened the message by using an email client that supports images.
DeleteRate (float) --
The percentage of email messages that were deleted by recipients, without being opened first. Due to technical limitations, this value only includes recipients who opened the message by using an email client that supports images.
ReadDeleteRate (float) --
The percentage of email messages that were opened and then deleted by recipients. Due to technical limitations, this value only includes recipients who opened the message by using an email client that supports images.
ProjectedVolume (integer) --
The projected number of recipients that the email message was sent to.
Esps (list) --
The major email providers who handled the email message.
(string) --
NextToken (string) --
A token that’s returned from a previous call to the ListDomainDeliverabilityCampaigns operation. This token indicates the position of the campaign in the list of campaigns.
{'Tags': [{'Key': 'string', 'Value': 'string'}]}
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
client.get_configuration_set(
ConfigurationSetName='string'
)
string
[REQUIRED]
The name of the configuration set that you want to obtain more information about.
dict
Response Syntax
{
'ConfigurationSetName': 'string',
'TrackingOptions': {
'CustomRedirectDomain': 'string'
},
'DeliveryOptions': {
'SendingPoolName': 'string'
},
'ReputationOptions': {
'ReputationMetricsEnabled': True|False,
'LastFreshStart': datetime(2015, 1, 1)
},
'SendingOptions': {
'SendingEnabled': True|False
},
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
Response Structure
(dict) --
Information about a configuration set.
ConfigurationSetName (string) --
The name of the configuration set.
TrackingOptions (dict) --
An object that defines the open and click tracking options for emails that you send using the configuration set.
CustomRedirectDomain (string) --
The domain that you want to use for tracking open and click events.
DeliveryOptions (dict) --
An object that defines the dedicated IP pool that is used to send emails that you send using the configuration set.
SendingPoolName (string) --
The name of the dedicated IP pool that you want to associate with the configuration set.
ReputationOptions (dict) --
An object that defines whether or not Amazon Pinpoint collects reputation metrics for the emails that you send that use the configuration set.
ReputationMetricsEnabled (boolean) --
If true , tracking of reputation metrics is enabled for the configuration set. If false , tracking of reputation metrics is disabled for the configuration set.
LastFreshStart (datetime) --
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.
SendingOptions (dict) --
An object that defines whether or not Amazon Pinpoint can send email that you send using the configuration set.
SendingEnabled (boolean) --
If true , email sending is enabled for the configuration set. If false , email sending is disabled for the configuration set.
Tags (list) --
An array of objects that define the tags (keys and values) that are associated with the configuration set.
(dict) --
An object that defines the tags that are associated with a 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 a more specific tag value. A tag value acts as a descriptor within a tag key. A tag key can contain as many as 128 characters. A tag value can contain as many as 256 characters. The characters can be Unicode letters, digits, white space, or one of the following symbols: _ . : / = + -. The following additional restrictions apply to tags:
Tag keys and values are case sensitive.
For each associated resource, each tag key must be unique and it can have only one value.
The aws: prefix is reserved for use by AWS; you can’t use it in any tag keys or values that you define. In addition, you can't edit or remove tag keys or values that use this prefix. Tags that use this prefix don’t count against the limit of 50 tags per resource.
You can associate tags with public or shared resources, but the tags are available only for your AWS account, not any other accounts that share the resource. In addition, the tags are available only for resources that are located in the specified AWS Region for your AWS account.
Key (string) --
One part of a key-value pair that defines a tag. The maximum length of a tag key is 128 characters. The minimum length is 1 character.
Value (string) --
The optional part of a key-value pair that defines a tag. The maximum length of a tag value is 256 characters. The minimum length is 0 characters. If you don’t want a resource to have a specific tag value, don’t specify a value for this parameter. Amazon Pinpoint will set the value to an empty string.
{'AccountStatus': 'ACTIVE | PENDING_EXPIRATION | DISABLED',
'ActiveSubscribedDomains': [{'Domain': 'string',
'InboxPlacementTrackingOption': {'Global': 'boolean',
'TrackedIsps': ['string']},
'SubscriptionStartDate': 'timestamp'}],
'PendingExpirationSubscribedDomains': [{'Domain': 'string',
'InboxPlacementTrackingOption': {'Global': 'boolean',
'TrackedIsps': ['string']},
'SubscriptionStartDate': 'timestamp'}],
'SubscriptionExpiryDate': 'timestamp'}
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.
See also: AWS API Documentation
Request Syntax
client.get_deliverability_dashboard_options()
dict
Response Syntax
{
'DashboardEnabled': True|False,
'SubscriptionExpiryDate': datetime(2015, 1, 1),
'AccountStatus': 'ACTIVE'|'PENDING_EXPIRATION'|'DISABLED',
'ActiveSubscribedDomains': [
{
'Domain': 'string',
'SubscriptionStartDate': datetime(2015, 1, 1),
'InboxPlacementTrackingOption': {
'Global': True|False,
'TrackedIsps': [
'string',
]
}
},
],
'PendingExpirationSubscribedDomains': [
{
'Domain': 'string',
'SubscriptionStartDate': datetime(2015, 1, 1),
'InboxPlacementTrackingOption': {
'Global': True|False,
'TrackedIsps': [
'string',
]
}
},
]
}
Response Structure
(dict) --
An object that shows the status of the Deliverability dashboard for your Amazon Pinpoint account.
DashboardEnabled (boolean) --
Specifies whether the Deliverability dashboard is enabled for your Amazon Pinpoint account. If this value is true , the dashboard is enabled.
SubscriptionExpiryDate (datetime) --
The date, in Unix time format, when your current subscription to the Deliverability dashboard is scheduled to expire, if your subscription is scheduled to expire at the end of the current calendar month. This value is null if you have an active subscription that isn’t due to expire at the end of the month.
AccountStatus (string) --
The current status of your Deliverability dashboard subscription. If this value is PENDING_EXPIRATION , your subscription is scheduled to expire at the end of the current calendar month.
ActiveSubscribedDomains (list) --
An array of objects, one for each verified domain that you use to send email and currently has an active Deliverability dashboard subscription that isn’t scheduled to expire at the end of the current calendar month.
(dict) --
An object that contains information about the Deliverability dashboard subscription for a verified domain that you use to send email and currently has an active Deliverability dashboard subscription. If a Deliverability dashboard subscription is active for a domain, you gain access to reputation, inbox placement, and other metrics for the domain.
Domain (string) --
A verified domain that’s associated with your AWS account and currently has an active Deliverability dashboard subscription.
SubscriptionStartDate (datetime) --
The date, in Unix time format, when you enabled the Deliverability dashboard for the domain.
InboxPlacementTrackingOption (dict) --
An object that contains information about the inbox placement data settings for the domain.
Global (boolean) --
Specifies whether inbox placement data is being tracked for the domain.
TrackedIsps (list) --
An array of strings, one for each major email provider that the inbox placement data applies to.
(string) --
The name of an email provider.
PendingExpirationSubscribedDomains (list) --
An array of objects, one for each verified domain that you use to send email and currently has an active Deliverability dashboard subscription that's scheduled to expire at the end of the current calendar month.
(dict) --
An object that contains information about the Deliverability dashboard subscription for a verified domain that you use to send email and currently has an active Deliverability dashboard subscription. If a Deliverability dashboard subscription is active for a domain, you gain access to reputation, inbox placement, and other metrics for the domain.
Domain (string) --
A verified domain that’s associated with your AWS account and currently has an active Deliverability dashboard subscription.
SubscriptionStartDate (datetime) --
The date, in Unix time format, when you enabled the Deliverability dashboard for the domain.
InboxPlacementTrackingOption (dict) --
An object that contains information about the inbox placement data settings for the domain.
Global (boolean) --
Specifies whether inbox placement data is being tracked for the domain.
TrackedIsps (list) --
An array of strings, one for each major email provider that the inbox placement data applies to.
(string) --
The name of an email provider.
{'Tags': [{'Key': 'string', 'Value': 'string'}]}
Retrieve the results of a predictive inbox placement test.
See also: AWS API Documentation
Request Syntax
client.get_deliverability_test_report(
ReportId='string'
)
string
[REQUIRED]
A unique string that identifies the predictive inbox placement test.
dict
Response Syntax
{
'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',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
Response Structure
(dict) --
The results of the predictive inbox placement test.
DeliverabilityTestReport (dict) --
An object that contains the results of the 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.
OverallPlacement (dict) --
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.
InboxPercentage (float) --
The percentage of emails that arrived in recipients' inboxes during the predictive inbox placement test.
SpamPercentage (float) --
The percentage of emails that arrived in recipients' spam or junk mail folders during the predictive inbox placement test.
MissingPercentage (float) --
The percentage of emails that didn't arrive in recipients' inboxes at all during the predictive inbox placement test.
SpfPercentage (float) --
The percentage of emails that were authenticated by using Sender Policy Framework (SPF) during the predictive inbox placement test.
DkimPercentage (float) --
The percentage of emails that were authenticated by using DomainKeys Identified Mail (DKIM) during the predictive inbox placement test.
IspPlacements (list) --
An object that describes how the test email was handled by several email providers, including Gmail, Hotmail, Yahoo, AOL, and others.
(dict) --
An object that describes how email sent during the predictive inbox placement test was handled by a certain email provider.
IspName (string) --
The name of the email provider that the inbox placement data applies to.
PlacementStatistics (dict) --
An object that contains inbox placement metrics for a specific email provider.
InboxPercentage (float) --
The percentage of emails that arrived in recipients' inboxes during the predictive inbox placement test.
SpamPercentage (float) --
The percentage of emails that arrived in recipients' spam or junk mail folders during the predictive inbox placement test.
MissingPercentage (float) --
The percentage of emails that didn't arrive in recipients' inboxes at all during the predictive inbox placement test.
SpfPercentage (float) --
The percentage of emails that were authenticated by using Sender Policy Framework (SPF) during the predictive inbox placement test.
DkimPercentage (float) --
The percentage of emails that were authenticated by using DomainKeys Identified Mail (DKIM) during the predictive inbox placement test.
Message (string) --
An object that contains the message that you sent when you performed this predictive inbox placement test.
Tags (list) --
An array of objects that define the tags (keys and values) that are associated with the predictive inbox placement test.
(dict) --
An object that defines the tags that are associated with a 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 a more specific tag value. A tag value acts as a descriptor within a tag key. A tag key can contain as many as 128 characters. A tag value can contain as many as 256 characters. The characters can be Unicode letters, digits, white space, or one of the following symbols: _ . : / = + -. The following additional restrictions apply to tags:
Tag keys and values are case sensitive.
For each associated resource, each tag key must be unique and it can have only one value.
The aws: prefix is reserved for use by AWS; you can’t use it in any tag keys or values that you define. In addition, you can't edit or remove tag keys or values that use this prefix. Tags that use this prefix don’t count against the limit of 50 tags per resource.
You can associate tags with public or shared resources, but the tags are available only for your AWS account, not any other accounts that share the resource. In addition, the tags are available only for resources that are located in the specified AWS Region for your AWS account.
Key (string) --
One part of a key-value pair that defines a tag. The maximum length of a tag key is 128 characters. The minimum length is 1 character.
Value (string) --
The optional part of a key-value pair that defines a tag. The maximum length of a tag value is 256 characters. The minimum length is 0 characters. If you don’t want a resource to have a specific tag value, don’t specify a value for this parameter. Amazon Pinpoint will set the value to an empty string.
{'Tags': [{'Key': 'string', 'Value': 'string'}]}
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
client.get_email_identity(
EmailIdentity='string'
)
string
[REQUIRED]
The email identity that you want to retrieve details for.
dict
Response Syntax
{
'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'
},
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
Response Structure
(dict) --
Details about an email identity.
IdentityType (string) --
The email identity type.
FeedbackForwardingStatus (boolean) --
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).
VerifiedForSendingStatus (boolean) --
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.
DkimAttributes (dict) --
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.
SigningEnabled (boolean) --
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.
Status (string) --
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:
PENDING – Amazon Pinpoint hasn't yet located the DKIM records in the DNS configuration for the domain, but will continue to attempt to locate them.
SUCCESS – Amazon Pinpoint located the DKIM records in the DNS configuration for the domain and determined that they're correct. Amazon Pinpoint can now send DKIM-signed email from the identity.
FAILED – Amazon Pinpoint was unable to locate the DKIM records in the DNS settings for the domain, and won't continue to search for them.
TEMPORARY_FAILURE – A temporary issue occurred, which prevented Amazon Pinpoint from determining the DKIM status for the domain.
NOT_STARTED – Amazon Pinpoint hasn't yet started searching for the DKIM records in the DKIM records for the domain.
Tokens (list) --
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.
(string) --
MailFromAttributes (dict) --
An object that contains information about the Mail-From attributes for the email identity.
MailFromDomain (string) --
The name of a domain that an email identity uses as a custom MAIL FROM domain.
MailFromDomainStatus (string) --
The status of the MAIL FROM domain. This status can have the following values:
PENDING – Amazon Pinpoint hasn't started searching for the MX record yet.
SUCCESS – Amazon Pinpoint detected the required MX record for the MAIL FROM domain.
FAILED – Amazon Pinpoint can't find the required MX record, or the record no longer exists.
TEMPORARY_FAILURE – A temporary issue occurred, which prevented Amazon Pinpoint from determining the status of the MAIL FROM domain.
BehaviorOnMxFailure (string) --
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.
Tags (list) --
An array of objects that define the tags (keys and values) that are associated with the email identity.
(dict) --
An object that defines the tags that are associated with a 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 a more specific tag value. A tag value acts as a descriptor within a tag key. A tag key can contain as many as 128 characters. A tag value can contain as many as 256 characters. The characters can be Unicode letters, digits, white space, or one of the following symbols: _ . : / = + -. The following additional restrictions apply to tags:
Tag keys and values are case sensitive.
For each associated resource, each tag key must be unique and it can have only one value.
The aws: prefix is reserved for use by AWS; you can’t use it in any tag keys or values that you define. In addition, you can't edit or remove tag keys or values that use this prefix. Tags that use this prefix don’t count against the limit of 50 tags per resource.
You can associate tags with public or shared resources, but the tags are available only for your AWS account, not any other accounts that share the resource. In addition, the tags are available only for resources that are located in the specified AWS Region for your AWS account.
Key (string) --
One part of a key-value pair that defines a tag. The maximum length of a tag key is 128 characters. The minimum length is 1 character.
Value (string) --
The optional part of a key-value pair that defines a tag. The maximum length of a tag value is 256 characters. The minimum length is 0 characters. If you don’t want a resource to have a specific tag value, don’t specify a value for this parameter. Amazon Pinpoint will set the value to an empty string.
{'SubscribedDomains': [{'Domain': 'string',
'InboxPlacementTrackingOption': {'Global': 'boolean',
'TrackedIsps': ['string']},
'SubscriptionStartDate': 'timestamp'}]}
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.
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.
See also: AWS API Documentation
Request Syntax
client.put_deliverability_dashboard_option(
DashboardEnabled=True|False,
SubscribedDomains=[
{
'Domain': 'string',
'SubscriptionStartDate': datetime(2015, 1, 1),
'InboxPlacementTrackingOption': {
'Global': True|False,
'TrackedIsps': [
'string',
]
}
},
]
)
boolean
[REQUIRED]
Specifies whether to enable the Deliverability dashboard for your Amazon Pinpoint account. To enable the dashboard, set this value to true .
list
An array of objects, one for each verified domain that you use to send email and enabled the Deliverability dashboard for.
(dict) --
An object that contains information about the Deliverability dashboard subscription for a verified domain that you use to send email and currently has an active Deliverability dashboard subscription. If a Deliverability dashboard subscription is active for a domain, you gain access to reputation, inbox placement, and other metrics for the domain.
Domain (string) --
A verified domain that’s associated with your AWS account and currently has an active Deliverability dashboard subscription.
SubscriptionStartDate (datetime) --
The date, in Unix time format, when you enabled the Deliverability dashboard for the domain.
InboxPlacementTrackingOption (dict) --
An object that contains information about the inbox placement data settings for the domain.
Global (boolean) --
Specifies whether inbox placement data is being tracked for the domain.
TrackedIsps (list) --
An array of strings, one for each major email provider that the inbox placement data applies to.
(string) --
The name of an email provider.
dict
Response Syntax
{}
Response Structure
(dict) --
A response that indicates whether the Deliverability dashboard is enabled for your Amazon Pinpoint account.