amazonka-sesv2-2.0: Amazon Simple Email Service SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.SESV2.GetDomainStatisticsReport

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

ToPath GetDomainStatisticsReport Source # 
Instance details

Defined in Amazonka.SESV2.GetDomainStatisticsReport

ToQuery GetDomainStatisticsReport Source # 
Instance details

Defined in Amazonka.SESV2.GetDomainStatisticsReport

AWSRequest GetDomainStatisticsReport Source # 
Instance details

Defined in Amazonka.SESV2.GetDomainStatisticsReport

Generic GetDomainStatisticsReport Source # 
Instance details

Defined in Amazonka.SESV2.GetDomainStatisticsReport

Associated Types

type Rep GetDomainStatisticsReport :: Type -> Type #

Read GetDomainStatisticsReport Source # 
Instance details

Defined in Amazonka.SESV2.GetDomainStatisticsReport

Show GetDomainStatisticsReport Source # 
Instance details

Defined in Amazonka.SESV2.GetDomainStatisticsReport

NFData GetDomainStatisticsReport Source # 
Instance details

Defined in Amazonka.SESV2.GetDomainStatisticsReport

Eq GetDomainStatisticsReport Source # 
Instance details

Defined in Amazonka.SESV2.GetDomainStatisticsReport

Hashable GetDomainStatisticsReport Source # 
Instance details

Defined in Amazonka.SESV2.GetDomainStatisticsReport

type AWSResponse GetDomainStatisticsReport Source # 
Instance details

Defined in Amazonka.SESV2.GetDomainStatisticsReport

type Rep GetDomainStatisticsReport Source # 
Instance details

Defined in Amazonka.SESV2.GetDomainStatisticsReport

type Rep GetDomainStatisticsReport = D1 ('MetaData "GetDomainStatisticsReport" "Amazonka.SESV2.GetDomainStatisticsReport" "amazonka-sesv2-2.0-KPRo1S1CRfP4bs5VKSgHvB" '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 #

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.

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

Associated Types

type Rep GetDomainStatisticsReportResponse :: Type -> Type #

Read GetDomainStatisticsReportResponse Source # 
Instance details

Defined in Amazonka.SESV2.GetDomainStatisticsReport

Show GetDomainStatisticsReportResponse Source # 
Instance details

Defined in Amazonka.SESV2.GetDomainStatisticsReport

NFData GetDomainStatisticsReportResponse Source # 
Instance details

Defined in Amazonka.SESV2.GetDomainStatisticsReport

Eq GetDomainStatisticsReportResponse Source # 
Instance details

Defined in Amazonka.SESV2.GetDomainStatisticsReport

type Rep GetDomainStatisticsReportResponse Source # 
Instance details

Defined in Amazonka.SESV2.GetDomainStatisticsReport

type Rep GetDomainStatisticsReportResponse = D1 ('MetaData "GetDomainStatisticsReportResponse" "Amazonka.SESV2.GetDomainStatisticsReport" "amazonka-sesv2-2.0-KPRo1S1CRfP4bs5VKSgHvB" '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 #

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