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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-pinpointemail/lib/aws-sdk-pinpointemail/types.rb

Overview

Note:

When making an API call, you may pass PutDeliverabilityDashboardOptionRequest data as a 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.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#dashboard_enabledBoolean

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

Returns:

  • (Boolean)


3085
3086
3087
3088
3089
3090
# File 'gems/aws-sdk-pinpointemail/lib/aws-sdk-pinpointemail/types.rb', line 3085

class PutDeliverabilityDashboardOptionRequest < Struct.new(
  :dashboard_enabled,
  :subscribed_domains)
  SENSITIVE = []
  include Aws::Structure
end

#subscribed_domainsArray<Types::DomainDeliverabilityTrackingOption>

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



3085
3086
3087
3088
3089
3090
# File 'gems/aws-sdk-pinpointemail/lib/aws-sdk-pinpointemail/types.rb', line 3085

class PutDeliverabilityDashboardOptionRequest < Struct.new(
  :dashboard_enabled,
  :subscribed_domains)
  SENSITIVE = []
  include Aws::Structure
end