PinpointEmail / Client / get_deliverability_dashboard_options

get_deliverability_dashboard_options#

PinpointEmail.Client.get_deliverability_dashboard_options()#

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

response = client.get_deliverability_dashboard_options()

Return type:

dict

Returns:

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.

Exceptions

PinpointEmail.Client.exceptions.TooManyRequestsException
PinpointEmail.Client.exceptions.LimitExceededException
PinpointEmail.Client.exceptions.BadRequestException