Class: Aws::SESV2::Types::BatchGetMetricDataQuery

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

Overview

Represents a single metric data query to include in a batch.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#dimensions ⇒ Hash<String,String>

An object that contains mapping between MetricDimensionName and MetricDimensionValue to filter metrics by.

Returns:

  • (Hash<String,String>) 


156
157
158
159
160
161
162
163
164
165
 
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/types.rb', line 156

class BatchGetMetricDataQuery < Struct.new(
  :id,
  :namespace,
  :metric,
  :dimensions,
  :start_date,
  :end_date)
  SENSITIVE = []
  include Aws::Structure
end

#end_date ⇒ Time

Represents the end date for the query interval.

Returns:

  • (Time) 


156
157
158
159
160
161
162
163
164
165
 
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/types.rb', line 156

class BatchGetMetricDataQuery < Struct.new(
  :id,
  :namespace,
  :metric,
  :dimensions,
  :start_date,
  :end_date)
  SENSITIVE = []
  include Aws::Structure
end

#id ⇒ String

The query identifier.

Returns:

  • (String) 


156
157
158
159
160
161
162
163
164
165
 
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/types.rb', line 156

class BatchGetMetricDataQuery < Struct.new(
  :id,
  :namespace,
  :metric,
  :dimensions,
  :start_date,
  :end_date)
  SENSITIVE = []
  include Aws::Structure
end

#metric ⇒ String

The queried metric. This can be one of the following:

  • SEND – Emails sent eligible for tracking in the VDM dashboard. This excludes emails sent to the mailbox simulator and emails addressed to more than one recipient.

  • COMPLAINT – Complaints received for your account. This excludes complaints from the mailbox simulator, those originating from your account-level suppression list (if enabled), and those for emails addressed to more than one recipient

  • PERMANENT_BOUNCE – Permanent bounces - i.e. feedback received for emails sent to non-existent mailboxes. Excludes bounces from the mailbox simulator, those originating from your account-level suppression list (if enabled), and those for emails addressed to more than one recipient.

  • TRANSIENT_BOUNCE – Transient bounces - i.e. feedback received for delivery failures excluding issues with non-existent mailboxes. Excludes bounces from the mailbox simulator, and those for emails addressed to more than one recipient.

  • OPEN – Unique open events for emails including open trackers. Excludes opens for emails addressed to more than one recipient.

  • CLICK – Unique click events for emails including wrapped links. Excludes clicks for emails addressed to more than one recipient.

  • DELIVERY – Successful deliveries for email sending attempts. Excludes deliveries to the mailbox simulator and for emails addressed to more than one recipient.

  • DELIVERY_OPEN – Successful deliveries for email sending attempts. Excludes deliveries to the mailbox simulator, for emails addressed to more than one recipient, and emails without open trackers.

  • DELIVERY_CLICK – Successful deliveries for email sending attempts. Excludes deliveries to the mailbox simulator, for emails addressed to more than one recipient, and emails without click trackers.

  • DELIVERY_COMPLAINT – Successful deliveries for email sending attempts. Excludes deliveries to the mailbox simulator, for emails addressed to more than one recipient, and emails addressed to recipients hosted by ISPs with which Amazon SES does not have a feedback loop agreement.

Returns:

  • (String) 


156
157
158
159
160
161
162
163
164
165
 
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/types.rb', line 156

class BatchGetMetricDataQuery < Struct.new(
  :id,
  :namespace,
  :metric,
  :dimensions,
  :start_date,
  :end_date)
  SENSITIVE = []
  include Aws::Structure
end

#namespace ⇒ String

The query namespace - e.g. VDM

Returns:

  • (String) 


156
157
158
159
160
161
162
163
164
165
 
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/types.rb', line 156

class BatchGetMetricDataQuery < Struct.new(
  :id,
  :namespace,
  :metric,
  :dimensions,
  :start_date,
  :end_date)
  SENSITIVE = []
  include Aws::Structure
end

#start_date ⇒ Time

Represents the start date for the query interval.

Returns:

  • (Time) 


156
157
158
159
160
161
162
163
164
165
 
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/types.rb', line 156

class BatchGetMetricDataQuery < Struct.new(
  :id,
  :namespace,
  :metric,
  :dimensions,
  :start_date,
  :end_date)
  SENSITIVE = []
  include Aws::Structure
end