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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Retrieve inbox placement and engagement rates for the domains that you use to send email.

Synopsis

Creating a Request

data GetDomainStatisticsReport Source #

A request to obtain deliverability metrics for a domain.

See: newGetDomainStatisticsReport smart constructor.

Constructors

GetDomainStatisticsReport'
Fields domain :: Text The domain that you want to obtain deliverability metrics for. startDate :: POSIX The first day (in Unix time) that you want to obtain domain deliverability metrics for. endDate :: POSIX The last day (in Unix time) that you want to obtain domain deliverability metrics for. The `EndDate` that you specify has to be less than or equal to 30 days after the `StartDate`.

Instances

Instances details

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

newGetDomainStatisticsReport Source #

Arguments

:: Text	`GetDomainStatisticsReport`
-> UTCTime	`GetDomainStatisticsReport`
-> UTCTime	`$sel:endDate:GetDomainStatisticsReport'`
-> GetDomainStatisticsReport

Create a value of GetDomainStatisticsReport 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:

GetDomainStatisticsReport, getDomainStatisticsReport_domain - The domain that you want to obtain deliverability metrics for.

GetDomainStatisticsReport, getDomainStatisticsReport_startDate - The first day (in Unix time) that you want to obtain domain deliverability metrics for.

$sel:endDate:GetDomainStatisticsReport', getDomainStatisticsReport_endDate - The last day (in Unix time) that you want to obtain domain deliverability metrics for. The EndDate that you specify has to be less than or equal to 30 days after the StartDate.

Request Lenses

getDomainStatisticsReport_domain :: Lens' GetDomainStatisticsReport Text Source #

The domain that you want to obtain deliverability metrics for.

getDomainStatisticsReport_startDate :: Lens' GetDomainStatisticsReport UTCTime Source #

The first day (in Unix time) that you want to obtain domain deliverability metrics for.

getDomainStatisticsReport_endDate :: Lens' GetDomainStatisticsReport UTCTime Source #

The last day (in Unix time) that you want to obtain domain deliverability metrics for. The EndDate that you specify has to be less than or equal to 30 days after the StartDate.

Destructuring the Response

data GetDomainStatisticsReportResponse Source #

An object that includes statistics that are related to the domain that you specified.

See: newGetDomainStatisticsReportResponse smart constructor.

Constructors

GetDomainStatisticsReportResponse'

Fields

httpStatus :: Int
The response's http status code.
overallVolume :: OverallVolume
An object that contains deliverability metrics for the domain that you specified. The data in this object is a summary of all of the data that was collected from the StartDate to the EndDate.
dailyVolumes :: [DailyVolume]
An object that contains deliverability metrics for the domain that you specified. This object contains data for each day, starting on the StartDate and ending on the EndDate.

Instances

Instances details

Generic GetDomainStatisticsReportResponse Source #
Instance details Defined in Amazonka.PinpointEmail.GetDomainStatisticsReport Associated Types type Rep GetDomainStatisticsReportResponse :: Type -> Type # Methods from :: GetDomainStatisticsReportResponse -> Rep GetDomainStatisticsReportResponse x # to :: Rep GetDomainStatisticsReportResponse x -> GetDomainStatisticsReportResponse #
Read GetDomainStatisticsReportResponse Source #
Instance details Defined in Amazonka.PinpointEmail.GetDomainStatisticsReport Methods readsPrec :: Int -> ReadS GetDomainStatisticsReportResponse # readList :: ReadS [GetDomainStatisticsReportResponse] # readPrec :: ReadPrec GetDomainStatisticsReportResponse # readListPrec :: ReadPrec [GetDomainStatisticsReportResponse] #
Show GetDomainStatisticsReportResponse Source #
Instance details Defined in Amazonka.PinpointEmail.GetDomainStatisticsReport Methods showsPrec :: Int -> GetDomainStatisticsReportResponse -> ShowS # show :: GetDomainStatisticsReportResponse -> String # showList :: [GetDomainStatisticsReportResponse] -> ShowS #
NFData GetDomainStatisticsReportResponse Source #
Instance details Defined in Amazonka.PinpointEmail.GetDomainStatisticsReport Methods rnf :: GetDomainStatisticsReportResponse -> () #
Eq GetDomainStatisticsReportResponse Source #
Instance details Defined in Amazonka.PinpointEmail.GetDomainStatisticsReport Methods (==) :: GetDomainStatisticsReportResponse -> GetDomainStatisticsReportResponse -> Bool # (/=) :: GetDomainStatisticsReportResponse -> GetDomainStatisticsReportResponse -> Bool #
type Rep GetDomainStatisticsReportResponse Source #
Instance details Defined in Amazonka.PinpointEmail.GetDomainStatisticsReport type Rep GetDomainStatisticsReportResponse = D1 ('MetaData "GetDomainStatisticsReportResponse" "Amazonka.PinpointEmail.GetDomainStatisticsReport" "amazonka-pinpoint-email-2.0-EgVsRBIHQXMGA9Xbyu2BvI" 'False) (C1 ('MetaCons "GetDomainStatisticsReportResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :: (S1 ('MetaSel ('Just "overallVolume") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 OverallVolume) :: S1 ('MetaSel ('Just "dailyVolumes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [DailyVolume]))))

newGetDomainStatisticsReportResponse Source #

Arguments

:: Int	`$sel:httpStatus:GetDomainStatisticsReportResponse'`
-> OverallVolume	`$sel:overallVolume:GetDomainStatisticsReportResponse'`
-> GetDomainStatisticsReportResponse

Create a value of GetDomainStatisticsReportResponse 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:httpStatus:GetDomainStatisticsReportResponse', getDomainStatisticsReportResponse_httpStatus - The response's http status code.

$sel:overallVolume:GetDomainStatisticsReportResponse', getDomainStatisticsReportResponse_overallVolume - An object that contains deliverability metrics for the domain that you specified. The data in this object is a summary of all of the data that was collected from the StartDate to the EndDate.

$sel:dailyVolumes:GetDomainStatisticsReportResponse', getDomainStatisticsReportResponse_dailyVolumes - An object that contains deliverability metrics for the domain that you specified. This object contains data for each day, starting on the StartDate and ending on the EndDate.

Response Lenses

getDomainStatisticsReportResponse_httpStatus :: Lens' GetDomainStatisticsReportResponse Int Source #

The response's http status code.

getDomainStatisticsReportResponse_overallVolume :: Lens' GetDomainStatisticsReportResponse OverallVolume Source #

An object that contains deliverability metrics for the domain that you specified. The data in this object is a summary of all of the data that was collected from the StartDate to the EndDate.

getDomainStatisticsReportResponse_dailyVolumes :: Lens' GetDomainStatisticsReportResponse [DailyVolume] Source #

An object that contains deliverability metrics for the domain that you specified. This object contains data for each day, starting on the StartDate and ending on the EndDate.