Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.PinpointEmail.GetDeliverabilityDashboardOptions

Contents

Creating a Request
Destructuring the Response
Response Lenses

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.

Constructors

GetDeliverabilityDashboardOptions'

Instances

Instances details

ToHeaders GetDeliverabilityDashboardOptions Source #
Instance details Defined in Amazonka.PinpointEmail.GetDeliverabilityDashboardOptions Methods toHeaders :: GetDeliverabilityDashboardOptions -> [Header] #
ToPath GetDeliverabilityDashboardOptions Source #
Instance details Defined in Amazonka.PinpointEmail.GetDeliverabilityDashboardOptions Methods toPath :: GetDeliverabilityDashboardOptions -> ByteString #
ToQuery GetDeliverabilityDashboardOptions Source #
Instance details Defined in Amazonka.PinpointEmail.GetDeliverabilityDashboardOptions Methods toQuery :: GetDeliverabilityDashboardOptions -> QueryString #
AWSRequest GetDeliverabilityDashboardOptions Source #
Instance details Defined in Amazonka.PinpointEmail.GetDeliverabilityDashboardOptions Associated Types type AWSResponse GetDeliverabilityDashboardOptions # Methods request :: (Service -> Service) -> GetDeliverabilityDashboardOptions -> Request GetDeliverabilityDashboardOptions # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetDeliverabilityDashboardOptions -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetDeliverabilityDashboardOptions))) #
Generic GetDeliverabilityDashboardOptions Source #
Instance details Defined in Amazonka.PinpointEmail.GetDeliverabilityDashboardOptions Associated Types type Rep GetDeliverabilityDashboardOptions :: Type -> Type # Methods from :: GetDeliverabilityDashboardOptions -> Rep GetDeliverabilityDashboardOptions x # to :: Rep GetDeliverabilityDashboardOptions x -> GetDeliverabilityDashboardOptions #
Read GetDeliverabilityDashboardOptions Source #
Instance details Defined in Amazonka.PinpointEmail.GetDeliverabilityDashboardOptions Methods readsPrec :: Int -> ReadS GetDeliverabilityDashboardOptions # readList :: ReadS [GetDeliverabilityDashboardOptions] # readPrec :: ReadPrec GetDeliverabilityDashboardOptions # readListPrec :: ReadPrec [GetDeliverabilityDashboardOptions] #
Show GetDeliverabilityDashboardOptions Source #
Instance details Defined in Amazonka.PinpointEmail.GetDeliverabilityDashboardOptions Methods showsPrec :: Int -> GetDeliverabilityDashboardOptions -> ShowS # show :: GetDeliverabilityDashboardOptions -> String # showList :: [GetDeliverabilityDashboardOptions] -> ShowS #
NFData GetDeliverabilityDashboardOptions Source #
Instance details Defined in Amazonka.PinpointEmail.GetDeliverabilityDashboardOptions Methods rnf :: GetDeliverabilityDashboardOptions -> () #
Eq GetDeliverabilityDashboardOptions Source #
Instance details Defined in Amazonka.PinpointEmail.GetDeliverabilityDashboardOptions Methods (==) :: GetDeliverabilityDashboardOptions -> GetDeliverabilityDashboardOptions -> Bool # (/=) :: GetDeliverabilityDashboardOptions -> GetDeliverabilityDashboardOptions -> Bool #
Hashable GetDeliverabilityDashboardOptions Source #
Instance details Defined in Amazonka.PinpointEmail.GetDeliverabilityDashboardOptions Methods hashWithSalt :: Int -> GetDeliverabilityDashboardOptions -> Int # hash :: GetDeliverabilityDashboardOptions -> Int #
type AWSResponse GetDeliverabilityDashboardOptions Source #
Instance details Defined in Amazonka.PinpointEmail.GetDeliverabilityDashboardOptions type AWSResponse GetDeliverabilityDashboardOptions = GetDeliverabilityDashboardOptionsResponse
type Rep GetDeliverabilityDashboardOptions Source #
Instance details Defined in Amazonka.PinpointEmail.GetDeliverabilityDashboardOptions type Rep GetDeliverabilityDashboardOptions = D1 ('MetaData "GetDeliverabilityDashboardOptions" "Amazonka.PinpointEmail.GetDeliverabilityDashboardOptions" "amazonka-pinpoint-email-2.0-EgVsRBIHQXMGA9Xbyu2BvI" 'False) (C1 ('MetaCons "GetDeliverabilityDashboardOptions'" 'PrefixI 'False) (U1 :: Type -> Type))

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.
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.
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.
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

Generic GetDeliverabilityDashboardOptionsResponse Source #
Instance details Defined in Amazonka.PinpointEmail.GetDeliverabilityDashboardOptions Associated Types type Rep GetDeliverabilityDashboardOptionsResponse :: Type -> Type # Methods from :: GetDeliverabilityDashboardOptionsResponse -> Rep GetDeliverabilityDashboardOptionsResponse x # to :: Rep GetDeliverabilityDashboardOptionsResponse x -> GetDeliverabilityDashboardOptionsResponse #
Read GetDeliverabilityDashboardOptionsResponse Source #
Instance details Defined in Amazonka.PinpointEmail.GetDeliverabilityDashboardOptions Methods readsPrec :: Int -> ReadS GetDeliverabilityDashboardOptionsResponse # readList :: ReadS [GetDeliverabilityDashboardOptionsResponse] # readPrec :: ReadPrec GetDeliverabilityDashboardOptionsResponse # readListPrec :: ReadPrec [GetDeliverabilityDashboardOptionsResponse] #
Show GetDeliverabilityDashboardOptionsResponse Source #
Instance details Defined in Amazonka.PinpointEmail.GetDeliverabilityDashboardOptions Methods showsPrec :: Int -> GetDeliverabilityDashboardOptionsResponse -> ShowS # show :: GetDeliverabilityDashboardOptionsResponse -> String # showList :: [GetDeliverabilityDashboardOptionsResponse] -> ShowS #
NFData GetDeliverabilityDashboardOptionsResponse Source #
Instance details Defined in Amazonka.PinpointEmail.GetDeliverabilityDashboardOptions Methods rnf :: GetDeliverabilityDashboardOptionsResponse -> () #
Eq GetDeliverabilityDashboardOptionsResponse Source #
Instance details Defined in Amazonka.PinpointEmail.GetDeliverabilityDashboardOptions Methods (==) :: GetDeliverabilityDashboardOptionsResponse -> GetDeliverabilityDashboardOptionsResponse -> Bool # (/=) :: GetDeliverabilityDashboardOptionsResponse -> GetDeliverabilityDashboardOptionsResponse -> Bool #
type Rep GetDeliverabilityDashboardOptionsResponse Source #
Instance details Defined in Amazonka.PinpointEmail.GetDeliverabilityDashboardOptions type Rep GetDeliverabilityDashboardOptionsResponse = D1 ('MetaData "GetDeliverabilityDashboardOptionsResponse" "Amazonka.PinpointEmail.GetDeliverabilityDashboardOptions" "amazonka-pinpoint-email-2.0-EgVsRBIHQXMGA9Xbyu2BvI" 'False) (C1 ('MetaCons "GetDeliverabilityDashboardOptionsResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "accountStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DeliverabilityDashboardAccountStatus)) :: (S1 ('MetaSel ('Just "activeSubscribedDomains") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [DomainDeliverabilityTrackingOption])) :: S1 ('MetaSel ('Just "pendingExpirationSubscribedDomains") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [DomainDeliverabilityTrackingOption])))) :: (S1 ('MetaSel ('Just "subscriptionExpiryDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "dashboardEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool)))))

newGetDeliverabilityDashboardOptionsResponse Source #

Arguments

:: Int	`$sel:httpStatus:GetDeliverabilityDashboardOptionsResponse'`
-> Bool	`$sel:dashboardEnabled:GetDeliverabilityDashboardOptionsResponse'`
-> GetDeliverabilityDashboardOptionsResponse

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: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: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: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_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_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_httpStatus :: Lens' GetDeliverabilityDashboardOptionsResponse Int Source #

The response's http status code.

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.