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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Retrieve deliverability data for all the campaigns that used a specific domain to send email during a specified time range. This data is available for a domain only if you enabled the Deliverability dashboard (PutDeliverabilityDashboardOption operation) for the domain.

Synopsis

Creating a Request

data ListDomainDeliverabilityCampaigns Source #

Retrieve deliverability data for all the campaigns that used a specific domain to send email during a specified time range. This data is available for a domain only if you enabled the Deliverability dashboard (PutDeliverabilityDashboardOption operation) for the domain.

See: newListDomainDeliverabilityCampaigns smart constructor.

Constructors

ListDomainDeliverabilityCampaigns'

Fields

nextToken :: Maybe Text
A token that’s returned from a previous call to the ListDomainDeliverabilityCampaigns operation. This token indicates the position of a campaign in the list of campaigns.
pageSize :: Maybe Int
The maximum number of results to include in response to a single call to the ListDomainDeliverabilityCampaigns operation. If the number of results is larger than the number that you specify in this parameter, the response includes a NextToken element, which you can use to obtain additional results.
startDate :: POSIX
The first day, in Unix time format, that you want to obtain deliverability data for.
endDate :: POSIX
The last day, in Unix time format, that you want to obtain deliverability data for. This value has to be less than or equal to 30 days after the value of the StartDate parameter.
subscribedDomain :: Text
The domain to obtain deliverability data for.

Instances

Instances details

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

newListDomainDeliverabilityCampaigns Source #

Arguments

:: UTCTime	`ListDomainDeliverabilityCampaigns`
-> UTCTime	`$sel:endDate:ListDomainDeliverabilityCampaigns'`
-> Text	`$sel:subscribedDomain:ListDomainDeliverabilityCampaigns'`
-> ListDomainDeliverabilityCampaigns

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

ListDomainDeliverabilityCampaigns, listDomainDeliverabilityCampaigns_nextToken - A token that’s returned from a previous call to the ListDomainDeliverabilityCampaigns operation. This token indicates the position of a campaign in the list of campaigns.

$sel:pageSize:ListDomainDeliverabilityCampaigns', listDomainDeliverabilityCampaigns_pageSize - The maximum number of results to include in response to a single call to the ListDomainDeliverabilityCampaigns operation. If the number of results is larger than the number that you specify in this parameter, the response includes a NextToken element, which you can use to obtain additional results.

ListDomainDeliverabilityCampaigns, listDomainDeliverabilityCampaigns_startDate - The first day, in Unix time format, that you want to obtain deliverability data for.

$sel:endDate:ListDomainDeliverabilityCampaigns', listDomainDeliverabilityCampaigns_endDate - The last day, in Unix time format, that you want to obtain deliverability data for. This value has to be less than or equal to 30 days after the value of the StartDate parameter.

$sel:subscribedDomain:ListDomainDeliverabilityCampaigns', listDomainDeliverabilityCampaigns_subscribedDomain - The domain to obtain deliverability data for.

Request Lenses

listDomainDeliverabilityCampaigns_nextToken :: Lens' ListDomainDeliverabilityCampaigns (Maybe Text) Source #

A token that’s returned from a previous call to the ListDomainDeliverabilityCampaigns operation. This token indicates the position of a campaign in the list of campaigns.

listDomainDeliverabilityCampaigns_pageSize :: Lens' ListDomainDeliverabilityCampaigns (Maybe Int) Source #

The maximum number of results to include in response to a single call to the ListDomainDeliverabilityCampaigns operation. If the number of results is larger than the number that you specify in this parameter, the response includes a NextToken element, which you can use to obtain additional results.

listDomainDeliverabilityCampaigns_startDate :: Lens' ListDomainDeliverabilityCampaigns UTCTime Source #

The first day, in Unix time format, that you want to obtain deliverability data for.

listDomainDeliverabilityCampaigns_endDate :: Lens' ListDomainDeliverabilityCampaigns UTCTime Source #

The last day, in Unix time format, that you want to obtain deliverability data for. This value has to be less than or equal to 30 days after the value of the StartDate parameter.

listDomainDeliverabilityCampaigns_subscribedDomain :: Lens' ListDomainDeliverabilityCampaigns Text Source #

The domain to obtain deliverability data for.

Destructuring the Response

data ListDomainDeliverabilityCampaignsResponse Source #

An array of objects that provide deliverability data for all the campaigns that used a specific domain to send email during a specified time range. This data is available for a domain only if you enabled the Deliverability dashboard (PutDeliverabilityDashboardOption operation) for the domain.

See: newListDomainDeliverabilityCampaignsResponse smart constructor.

Constructors

ListDomainDeliverabilityCampaignsResponse'

Fields

nextToken :: Maybe Text
A token that’s returned from a previous call to the ListDomainDeliverabilityCampaigns operation. This token indicates the position of the campaign in the list of campaigns.
httpStatus :: Int
The response's http status code.
domainDeliverabilityCampaigns :: [DomainDeliverabilityCampaign]
An array of responses, one for each campaign that used the domain to send email during the specified time range.

Instances

Instances details

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

newListDomainDeliverabilityCampaignsResponse Source #

Arguments

:: Int	`$sel:httpStatus:ListDomainDeliverabilityCampaignsResponse'`
-> ListDomainDeliverabilityCampaignsResponse

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

ListDomainDeliverabilityCampaigns, listDomainDeliverabilityCampaignsResponse_nextToken - A token that’s returned from a previous call to the ListDomainDeliverabilityCampaigns operation. This token indicates the position of the campaign in the list of campaigns.

$sel:httpStatus:ListDomainDeliverabilityCampaignsResponse', listDomainDeliverabilityCampaignsResponse_httpStatus - The response's http status code.

$sel:domainDeliverabilityCampaigns:ListDomainDeliverabilityCampaignsResponse', listDomainDeliverabilityCampaignsResponse_domainDeliverabilityCampaigns - An array of responses, one for each campaign that used the domain to send email during the specified time range.

Response Lenses

listDomainDeliverabilityCampaignsResponse_nextToken :: Lens' ListDomainDeliverabilityCampaignsResponse (Maybe Text) Source #

A token that’s returned from a previous call to the ListDomainDeliverabilityCampaigns operation. This token indicates the position of the campaign in the list of campaigns.

listDomainDeliverabilityCampaignsResponse_httpStatus :: Lens' ListDomainDeliverabilityCampaignsResponse Int Source #

The response's http status code.

listDomainDeliverabilityCampaignsResponse_domainDeliverabilityCampaigns :: Lens' ListDomainDeliverabilityCampaignsResponse [DomainDeliverabilityCampaign] Source #

An array of responses, one for each campaign that used the domain to send email during the specified time range.