Struct aws_sdk_sesv2::types::BatchGetMetricDataQuery

#[non_exhaustive]
pub struct BatchGetMetricDataQuery {
    pub id: String,
    pub namespace: MetricNamespace,
    pub metric: Metric,
    pub dimensions: Option<HashMap<MetricDimensionName, String>>,
    pub start_date: DateTime,
    pub end_date: DateTime,
}

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

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

id: String

The query identifier.

namespace: MetricNamespace

The query namespace - e.g. VDM

metric: Metric

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.

dimensions: Option<HashMap<MetricDimensionName, String>>

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

start_date: DateTime

Represents the start date for the query interval.

end_date: DateTime

Represents the end date for the query interval.

Implementations

impl BatchGetMetricDataQuery

pub fn id(&self) -> &str

The query identifier.

pub fn namespace(&self) -> &MetricNamespace

The query namespace - e.g. VDM

pub fn metric(&self) -> &Metric

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.

pub fn dimensions(&self) -> Option<&HashMap<MetricDimensionName, String>>

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

pub fn start_date(&self) -> &DateTime

Represents the start date for the query interval.

pub fn end_date(&self) -> &DateTime

Represents the end date for the query interval.

impl BatchGetMetricDataQuery

pub fn builder() -> BatchGetMetricDataQueryBuilder

Creates a new builder-style object to manufacture BatchGetMetricDataQuery.

Trait Implementations

impl Clone for BatchGetMetricDataQuery

fn clone(&self) -> BatchGetMetricDataQuery

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for BatchGetMetricDataQuery

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for BatchGetMetricDataQuery

fn eq(&self, other: &BatchGetMetricDataQuery) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for BatchGetMetricDataQuery