Skip to content

GetDeliverabilityDashboardOptionsResponse

Source code in docs_src/capo_pinpoint_email/types/get_deliverability_dashboard_options_response.py
class GetDeliverabilityDashboardOptionsResponse(TypedDict, closed=True):
    dashboard_enabled: "capo_pinpoint_email.types.enabled.Enabled"
    """<p>Specifies whether the Deliverability dashboard is enabled for your Amazon Pinpoint account. If this value is <code>true</code>, the dashboard is enabled.</p>"""
    subscription_expiry_date: NotRequired[
        "capo_pinpoint_email.types.timestamp.Timestamp"
    ]
    """<p>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.</p>"""
    account_status: NotRequired[
        "capo_pinpoint_email.types.deliverability_dashboard_account_status.DeliverabilityDashboardAccountStatus"
    ]
    """<p>The current status of your Deliverability dashboard subscription. If this value is <code>PENDING_EXPIRATION</code>, your subscription is scheduled to expire at the end of the current calendar month.</p>"""
    active_subscribed_domains: NotRequired[
        "capo_pinpoint_email.types.domain_deliverability_tracking_options.DomainDeliverabilityTrackingOptions"
    ]
    """<p>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.</p>"""
    pending_expiration_subscribed_domains: NotRequired[
        "capo_pinpoint_email.types.domain_deliverability_tracking_options.DomainDeliverabilityTrackingOptions"
    ]
    """<p>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.</p>"""

account_status instance-attribute

account_status: NotRequired[DeliverabilityDashboardAccountStatus]

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.

active_subscribed_domains instance-attribute

active_subscribed_domains: NotRequired[DomainDeliverabilityTrackingOptions]

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.

dashboard_enabled instance-attribute

dashboard_enabled: Enabled

Specifies whether the Deliverability dashboard is enabled for your Amazon Pinpoint account. If this value is true, the dashboard is enabled.

pending_expiration_subscribed_domains instance-attribute

pending_expiration_subscribed_domains: NotRequired[DomainDeliverabilityTrackingOptions]

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.

subscription_expiry_date instance-attribute

subscription_expiry_date: NotRequired[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.