get-domain-deliverability-campaign¶
Description¶
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.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
Synopsis¶
get-domain-deliverability-campaign
--campaign-id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]
Options¶
--campaign-id (string)
The unique identifier for the campaign. The Deliverability dashboard automatically generates and assigns this identifier to a campaign.
--cli-input-json | --cli-input-yaml (string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.
--generate-cli-skeleton (string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.
--cli-auto-prompt (boolean)
Automatically prompt for CLI input parameters.
See ‘aws help’ for descriptions of global parameters.
Output¶
DomainDeliverabilityCampaign -> (structure)
An object that contains the deliverability data for the campaign.
CampaignId -> (string)
The unique identifier for the campaign. The Deliverability dashboard automatically generates and assigns this identifier to a campaign.
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)
An IPv4 address.
FirstSeenDateTime -> (timestamp)
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 -> (timestamp)
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 -> (long)
The number of email messages that were delivered to recipients’ inboxes.
SpamCount -> (long)
The number of email messages that were delivered to recipients’ spam or junk mail folders.
ReadRate -> (double)
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 -> (double)
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 -> (double)
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 -> (long)
The projected number of recipients that the email message was sent to.
Esps -> (list)
The major email providers who handled the email message.
(string)