AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::SESV2::Types::ListDomainDeliverabilityCampaignsRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

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.

Instance Attribute Summary collapse

Instance Attribute Details

#end_dateTime

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.

Returns:

  • (Time)

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

#next_tokenString

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.

Returns:

  • (String)

    A token that’s returned from a previous call to the ListDomainDeliverabilityCampaigns operation.

#page_sizeInteger

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.

Returns:

  • (Integer)

    The maximum number of results to include in response to a single call to the ListDomainDeliverabilityCampaigns operation.

#start_dateTime

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

Returns:

  • (Time)

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

#subscribed_domainString

The domain to obtain deliverability data for.

Returns:

  • (String)

    The domain to obtain deliverability data for.