Documentation

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

See: newDomainDeliverabilityCampaign smart constructor.

Create a value of DomainDeliverabilityCampaign with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:spamCount:DomainDeliverabilityCampaign', domainDeliverabilityCampaign_spamCount - The number of email messages that were delivered to recipients' spam or junk mail folders.

$sel:subject:DomainDeliverabilityCampaign', domainDeliverabilityCampaign_subject - The subject line, or title, of the email message.

$sel:esps:DomainDeliverabilityCampaign', domainDeliverabilityCampaign_esps - The major email providers who handled the email message.

$sel:fromAddress:DomainDeliverabilityCampaign', domainDeliverabilityCampaign_fromAddress - The verified email address that the email message was sent from.

$sel:deleteRate:DomainDeliverabilityCampaign', domainDeliverabilityCampaign_deleteRate - 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.

$sel:campaignId:DomainDeliverabilityCampaign', domainDeliverabilityCampaign_campaignId - 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.

$sel:sendingIps:DomainDeliverabilityCampaign', domainDeliverabilityCampaign_sendingIps - The IP addresses that were used to send the email message.

$sel:firstSeenDateTime:DomainDeliverabilityCampaign', domainDeliverabilityCampaign_firstSeenDateTime - 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.

$sel:inboxCount:DomainDeliverabilityCampaign', domainDeliverabilityCampaign_inboxCount - The number of email messages that were delivered to recipients’ inboxes.

$sel:readDeleteRate:DomainDeliverabilityCampaign', domainDeliverabilityCampaign_readDeleteRate - 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.

$sel:projectedVolume:DomainDeliverabilityCampaign', domainDeliverabilityCampaign_projectedVolume - The projected number of recipients that the email message was sent to.

$sel:imageUrl:DomainDeliverabilityCampaign', domainDeliverabilityCampaign_imageUrl - The URL of an image that contains a snapshot of the email message that was sent.

$sel:readRate:DomainDeliverabilityCampaign', domainDeliverabilityCampaign_readRate - 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.

$sel:lastSeenDateTime:DomainDeliverabilityCampaign', domainDeliverabilityCampaign_lastSeenDateTime - 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.

The number of email messages that were delivered to recipients' spam or junk mail folders.

The subject line, or title, of the email message.

The major email providers who handled the email message.

The verified email address that the email message was sent from.

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.

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.

The IP addresses that were used to send the email message.

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.

The number of email messages that were delivered to recipients’ inboxes.

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.

The projected number of recipients that the email message was sent to.

The URL of an image that contains a snapshot of the email message that was sent.

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.

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.