You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::PinpointEmail::Types::PutDeliverabilityDashboardOptionRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing PutDeliverabilityDashboardOptionRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  dashboard_enabled: false, # required
  subscribed_domains: [
    {
      domain: "Domain",
      subscription_start_date: Time.now,
      inbox_placement_tracking_option: {
        global: false,
        tracked_isps: ["IspName"],
      },
    },
  ],
}

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.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#dashboard_enabled ⇒ Boolean

Specifies whether to enable the Deliverability dashboard for your Amazon Pinpoint account. To enable the dashboard, set this value to true.

Returns:

  • (Boolean) —

    Specifies whether to enable the Deliverability dashboard for your Amazon Pinpoint account.

#subscribed_domains ⇒ Array<Types::DomainDeliverabilityTrackingOption>

An array of objects, one for each verified domain that you use to send email and enabled the Deliverability dashboard for.

Returns: