You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::PinpointEmail::Types::ListDomainDeliverabilityCampaignsRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::PinpointEmail::Types::ListDomainDeliverabilityCampaignsRequest
- Defined in:
- (unknown)
Overview
When passing ListDomainDeliverabilityCampaignsRequest as input to an Aws::Client method, you can use a vanilla Hash:
{
start_date: Time.now, # required
end_date: Time.now, # required
subscribed_domain: "Domain", # required
next_token: "NextToken",
page_size: 1,
}
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.
Instance Attribute Summary collapse
-
#end_date ⇒ Time
The last day, in Unix time format, that you want to obtain deliverability data for.
-
#next_token ⇒ String
A token that’s returned from a previous call to the
ListDomainDeliverabilityCampaigns
operation. -
#page_size ⇒ Integer
The maximum number of results to include in response to a single call to the
ListDomainDeliverabilityCampaigns
operation. -
#start_date ⇒ Time
The first day, in Unix time format, that you want to obtain deliverability data for.
-
#subscribed_domain ⇒ String
The domain to obtain deliverability data for.
Instance Attribute Details
#end_date ⇒ Time
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.
#next_token ⇒ String
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.
#page_size ⇒ Integer
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.
#start_date ⇒ Time
The first day, in Unix time format, that you want to obtain deliverability data for.
#subscribed_domain ⇒ String
The domain to obtain deliverability data for.