Class: Aws::PinpointEmail::Types::ListDomainDeliverabilityCampaignsRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-pinpointemail/lib/aws-sdk-pinpointemail/types.rb

Overview

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 Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

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.

Returns:

  • (Time) 


1963
1964
1965
1966
1967
1968
1969
1970
1971
 
# File 'gems/aws-sdk-pinpointemail/lib/aws-sdk-pinpointemail/types.rb', line 1963

class ListDomainDeliverabilityCampaignsRequest < Struct.new(
  :start_date,
  :end_date,
  :subscribed_domain,
  :next_token,
  :page_size)
  SENSITIVE = []
  include Aws::Structure
end

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

Returns:

  • (String) 


1963
1964
1965
1966
1967
1968
1969
1970
1971
 
# File 'gems/aws-sdk-pinpointemail/lib/aws-sdk-pinpointemail/types.rb', line 1963

class ListDomainDeliverabilityCampaignsRequest < Struct.new(
  :start_date,
  :end_date,
  :subscribed_domain,
  :next_token,
  :page_size)
  SENSITIVE = []
  include Aws::Structure
end

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

Returns:

  • (Integer) 


1963
1964
1965
1966
1967
1968
1969
1970
1971
 
# File 'gems/aws-sdk-pinpointemail/lib/aws-sdk-pinpointemail/types.rb', line 1963

class ListDomainDeliverabilityCampaignsRequest < Struct.new(
  :start_date,
  :end_date,
  :subscribed_domain,
  :next_token,
  :page_size)
  SENSITIVE = []
  include Aws::Structure
end

#start_date ⇒ Time

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

Returns:

  • (Time) 


1963
1964
1965
1966
1967
1968
1969
1970
1971
 
# File 'gems/aws-sdk-pinpointemail/lib/aws-sdk-pinpointemail/types.rb', line 1963

class ListDomainDeliverabilityCampaignsRequest < Struct.new(
  :start_date,
  :end_date,
  :subscribed_domain,
  :next_token,
  :page_size)
  SENSITIVE = []
  include Aws::Structure
end

#subscribed_domain ⇒ String

The domain to obtain deliverability data for.

Returns:

  • (String) 


1963
1964
1965
1966
1967
1968
1969
1970
1971
 
# File 'gems/aws-sdk-pinpointemail/lib/aws-sdk-pinpointemail/types.rb', line 1963

class ListDomainDeliverabilityCampaignsRequest < Struct.new(
  :start_date,
  :end_date,
  :subscribed_domain,
  :next_token,
  :page_size)
  SENSITIVE = []
  include Aws::Structure
end