| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.PinpointEmail.ListDomainDeliverabilityCampaigns
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
- data ListDomainDeliverabilityCampaigns = ListDomainDeliverabilityCampaigns' {}
- newListDomainDeliverabilityCampaigns :: UTCTime -> UTCTime -> Text -> ListDomainDeliverabilityCampaigns
- listDomainDeliverabilityCampaigns_nextToken :: Lens' ListDomainDeliverabilityCampaigns (Maybe Text)
- listDomainDeliverabilityCampaigns_pageSize :: Lens' ListDomainDeliverabilityCampaigns (Maybe Int)
- listDomainDeliverabilityCampaigns_startDate :: Lens' ListDomainDeliverabilityCampaigns UTCTime
- listDomainDeliverabilityCampaigns_endDate :: Lens' ListDomainDeliverabilityCampaigns UTCTime
- listDomainDeliverabilityCampaigns_subscribedDomain :: Lens' ListDomainDeliverabilityCampaigns Text
- data ListDomainDeliverabilityCampaignsResponse = ListDomainDeliverabilityCampaignsResponse' {}
- newListDomainDeliverabilityCampaignsResponse :: Int -> ListDomainDeliverabilityCampaignsResponse
- listDomainDeliverabilityCampaignsResponse_nextToken :: Lens' ListDomainDeliverabilityCampaignsResponse (Maybe Text)
- listDomainDeliverabilityCampaignsResponse_httpStatus :: Lens' ListDomainDeliverabilityCampaignsResponse Int
- listDomainDeliverabilityCampaignsResponse_domainDeliverabilityCampaigns :: Lens' ListDomainDeliverabilityCampaignsResponse [DomainDeliverabilityCampaign]
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
| |
Instances
newListDomainDeliverabilityCampaigns Source #
Arguments
| :: UTCTime | |
| -> UTCTime | |
| -> Text | |
| -> 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:
$sel:nextToken: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.
$sel:startDate: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
| |
Instances
newListDomainDeliverabilityCampaignsResponse Source #
Arguments
| :: Int | |
| -> 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:
$sel:nextToken: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.