libZSservicesZSamazonka-pinpoint-emailZSamazonka-pinpoint-email
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.PinpointEmail.GetDeliverabilityDashboardOptions

Description

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.

Synopsis

Creating a Request

data GetDeliverabilityDashboardOptions Source #

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: newGetDeliverabilityDashboardOptions smart constructor.

Instances

Instances details
Eq GetDeliverabilityDashboardOptions Source # 
Instance details

Defined in Amazonka.PinpointEmail.GetDeliverabilityDashboardOptions

Read GetDeliverabilityDashboardOptions Source # 
Instance details

Defined in Amazonka.PinpointEmail.GetDeliverabilityDashboardOptions

Show GetDeliverabilityDashboardOptions Source # 
Instance details

Defined in Amazonka.PinpointEmail.GetDeliverabilityDashboardOptions

Generic GetDeliverabilityDashboardOptions Source # 
Instance details

Defined in Amazonka.PinpointEmail.GetDeliverabilityDashboardOptions

Associated Types

type Rep GetDeliverabilityDashboardOptions :: Type -> Type #

NFData GetDeliverabilityDashboardOptions Source # 
Instance details

Defined in Amazonka.PinpointEmail.GetDeliverabilityDashboardOptions

Hashable GetDeliverabilityDashboardOptions Source # 
Instance details

Defined in Amazonka.PinpointEmail.GetDeliverabilityDashboardOptions

AWSRequest GetDeliverabilityDashboardOptions Source # 
Instance details

Defined in Amazonka.PinpointEmail.GetDeliverabilityDashboardOptions

ToHeaders GetDeliverabilityDashboardOptions Source # 
Instance details

Defined in Amazonka.PinpointEmail.GetDeliverabilityDashboardOptions

ToPath GetDeliverabilityDashboardOptions Source # 
Instance details

Defined in Amazonka.PinpointEmail.GetDeliverabilityDashboardOptions

ToQuery GetDeliverabilityDashboardOptions Source # 
Instance details

Defined in Amazonka.PinpointEmail.GetDeliverabilityDashboardOptions

type Rep GetDeliverabilityDashboardOptions Source # 
Instance details

Defined in Amazonka.PinpointEmail.GetDeliverabilityDashboardOptions

type Rep GetDeliverabilityDashboardOptions = D1 ('MetaData "GetDeliverabilityDashboardOptions" "Amazonka.PinpointEmail.GetDeliverabilityDashboardOptions" "libZSservicesZSamazonka-pinpoint-emailZSamazonka-pinpoint-email" 'False) (C1 ('MetaCons "GetDeliverabilityDashboardOptions'" 'PrefixI 'False) (U1 :: Type -> Type))
type AWSResponse GetDeliverabilityDashboardOptions Source # 
Instance details

Defined in Amazonka.PinpointEmail.GetDeliverabilityDashboardOptions

newGetDeliverabilityDashboardOptions :: GetDeliverabilityDashboardOptions Source #

Create a value of GetDeliverabilityDashboardOptions with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

Destructuring the Response

data GetDeliverabilityDashboardOptionsResponse Source #

An object that shows the status of the Deliverability dashboard for your Amazon Pinpoint account.

See: newGetDeliverabilityDashboardOptionsResponse smart constructor.

Constructors

GetDeliverabilityDashboardOptionsResponse' 

Fields

  • accountStatus :: Maybe 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.

  • subscriptionExpiryDate :: Maybe POSIX

    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.

  • activeSubscribedDomains :: Maybe [DomainDeliverabilityTrackingOption]

    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.

  • pendingExpirationSubscribedDomains :: Maybe [DomainDeliverabilityTrackingOption]

    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.

  • httpStatus :: Int

    The response's http status code.

  • dashboardEnabled :: Bool

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

Instances

Instances details
Eq GetDeliverabilityDashboardOptionsResponse Source # 
Instance details

Defined in Amazonka.PinpointEmail.GetDeliverabilityDashboardOptions

Read GetDeliverabilityDashboardOptionsResponse Source # 
Instance details

Defined in Amazonka.PinpointEmail.GetDeliverabilityDashboardOptions

Show GetDeliverabilityDashboardOptionsResponse Source # 
Instance details

Defined in Amazonka.PinpointEmail.GetDeliverabilityDashboardOptions

Generic GetDeliverabilityDashboardOptionsResponse Source # 
Instance details

Defined in Amazonka.PinpointEmail.GetDeliverabilityDashboardOptions

NFData GetDeliverabilityDashboardOptionsResponse Source # 
Instance details

Defined in Amazonka.PinpointEmail.GetDeliverabilityDashboardOptions

type Rep GetDeliverabilityDashboardOptionsResponse Source # 
Instance details

Defined in Amazonka.PinpointEmail.GetDeliverabilityDashboardOptions

type Rep GetDeliverabilityDashboardOptionsResponse = D1 ('MetaData "GetDeliverabilityDashboardOptionsResponse" "Amazonka.PinpointEmail.GetDeliverabilityDashboardOptions" "libZSservicesZSamazonka-pinpoint-emailZSamazonka-pinpoint-email" 'False) (C1 ('MetaCons "GetDeliverabilityDashboardOptionsResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "accountStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DeliverabilityDashboardAccountStatus)) :*: (S1 ('MetaSel ('Just "subscriptionExpiryDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "activeSubscribedDomains") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [DomainDeliverabilityTrackingOption])))) :*: (S1 ('MetaSel ('Just "pendingExpirationSubscribedDomains") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [DomainDeliverabilityTrackingOption])) :*: (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "dashboardEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool)))))

newGetDeliverabilityDashboardOptionsResponse Source #

Create a value of GetDeliverabilityDashboardOptionsResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:accountStatus:GetDeliverabilityDashboardOptionsResponse', getDeliverabilityDashboardOptionsResponse_accountStatus - 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.

$sel:subscriptionExpiryDate:GetDeliverabilityDashboardOptionsResponse', getDeliverabilityDashboardOptionsResponse_subscriptionExpiryDate - 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.

$sel:activeSubscribedDomains:GetDeliverabilityDashboardOptionsResponse', getDeliverabilityDashboardOptionsResponse_activeSubscribedDomains - 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.

$sel:pendingExpirationSubscribedDomains:GetDeliverabilityDashboardOptionsResponse', getDeliverabilityDashboardOptionsResponse_pendingExpirationSubscribedDomains - 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.

$sel:httpStatus:GetDeliverabilityDashboardOptionsResponse', getDeliverabilityDashboardOptionsResponse_httpStatus - The response's http status code.

$sel:dashboardEnabled:GetDeliverabilityDashboardOptionsResponse', getDeliverabilityDashboardOptionsResponse_dashboardEnabled - Specifies whether the Deliverability dashboard is enabled for your Amazon Pinpoint account. If this value is true, the dashboard is enabled.

Response Lenses

getDeliverabilityDashboardOptionsResponse_accountStatus :: Lens' GetDeliverabilityDashboardOptionsResponse (Maybe DeliverabilityDashboardAccountStatus) Source #

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.

getDeliverabilityDashboardOptionsResponse_subscriptionExpiryDate :: Lens' GetDeliverabilityDashboardOptionsResponse (Maybe UTCTime) Source #

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.

getDeliverabilityDashboardOptionsResponse_activeSubscribedDomains :: Lens' GetDeliverabilityDashboardOptionsResponse (Maybe [DomainDeliverabilityTrackingOption]) Source #

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.

getDeliverabilityDashboardOptionsResponse_pendingExpirationSubscribedDomains :: Lens' GetDeliverabilityDashboardOptionsResponse (Maybe [DomainDeliverabilityTrackingOption]) Source #

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.

getDeliverabilityDashboardOptionsResponse_dashboardEnabled :: Lens' GetDeliverabilityDashboardOptionsResponse Bool Source #

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