PinpointEmail / Client / put_deliverability_dashboard_option

put_deliverability_dashboard_option#

PinpointEmail.Client.put_deliverability_dashboard_option(**kwargs)#

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.

Request Syntax

response = client.put_deliverability_dashboard_option(
    DashboardEnabled=True|False,
    SubscribedDomains=[
        {
            'Domain': 'string',
            'SubscriptionStartDate': datetime(2015, 1, 1),
            'InboxPlacementTrackingOption': {
                'Global': True|False,
                'TrackedIsps': [
                    'string',
                ]
            }
        },
    ]
)

Parameters:

DashboardEnabled (boolean) –
[REQUIRED]

Specifies whether to enable the Deliverability dashboard for your Amazon Pinpoint account. To enable the dashboard, set this value to true.
SubscribedDomains (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.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

(dict) –

A response that indicates whether the Deliverability dashboard is enabled for your Amazon Pinpoint account.

Exceptions

PinpointEmail.Client.exceptions.AlreadyExistsException
PinpointEmail.Client.exceptions.NotFoundException
PinpointEmail.Client.exceptions.TooManyRequestsException
PinpointEmail.Client.exceptions.LimitExceededException
PinpointEmail.Client.exceptions.BadRequestException