get-deliverability-dashboard-options¶
Description¶
Retrieve information about the status of the Deliverability dashboard for your 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. 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 SES and other AWS services. For more information about the features and cost of a Deliverability dashboard subscription, see Amazon SES Pricing .
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
Synopsis¶
get-deliverability-dashboard-options
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
Options¶
--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.
See ‘aws help’ for descriptions of global parameters.
Output¶
DashboardEnabled -> (boolean)
Specifies whether the Deliverability dashboard is enabled. If this value is
true, the dashboard is enabled.
SubscriptionExpiryDate -> (timestamp)
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.
(structure)
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 -> (timestamp)
The date, in Unix time format, when you enabled the Deliverability dashboard for the domain.
InboxPlacementTrackingOption -> (structure)
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.
(structure)
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 -> (timestamp)
The date, in Unix time format, when you enabled the Deliverability dashboard for the domain.
InboxPlacementTrackingOption -> (structure)
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.