Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.SESV2.Types.BatchGetMetricDataQuery

Description

Documentation

data BatchGetMetricDataQuery Source #

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

See: newBatchGetMetricDataQuery smart constructor.

Constructors

BatchGetMetricDataQuery'

Fields

dimensions :: Maybe (HashMap MetricDimensionName Text)
An object that contains mapping between MetricDimensionName and MetricDimensionValue to filter metrics by.
id :: Text
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.
startDate :: POSIX
Represents the start date for the query interval.
endDate :: POSIX
Represents the end date for the query interval.

Instances

Instances details

ToJSON BatchGetMetricDataQuery Source #
Instance details Defined in Amazonka.SESV2.Types.BatchGetMetricDataQuery Methods toJSON :: BatchGetMetricDataQuery -> Value # toEncoding :: BatchGetMetricDataQuery -> Encoding # toJSONList :: [BatchGetMetricDataQuery] -> Value # toEncodingList :: [BatchGetMetricDataQuery] -> Encoding #
Generic BatchGetMetricDataQuery Source #
Instance details Defined in Amazonka.SESV2.Types.BatchGetMetricDataQuery Associated Types type Rep BatchGetMetricDataQuery :: Type -> Type # Methods from :: BatchGetMetricDataQuery -> Rep BatchGetMetricDataQuery x # to :: Rep BatchGetMetricDataQuery x -> BatchGetMetricDataQuery #
Read BatchGetMetricDataQuery Source #
Instance details Defined in Amazonka.SESV2.Types.BatchGetMetricDataQuery Methods readsPrec :: Int -> ReadS BatchGetMetricDataQuery # readList :: ReadS [BatchGetMetricDataQuery] # readPrec :: ReadPrec BatchGetMetricDataQuery # readListPrec :: ReadPrec [BatchGetMetricDataQuery] #
Show BatchGetMetricDataQuery Source #
Instance details Defined in Amazonka.SESV2.Types.BatchGetMetricDataQuery Methods showsPrec :: Int -> BatchGetMetricDataQuery -> ShowS # show :: BatchGetMetricDataQuery -> String # showList :: [BatchGetMetricDataQuery] -> ShowS #
NFData BatchGetMetricDataQuery Source #
Instance details Defined in Amazonka.SESV2.Types.BatchGetMetricDataQuery Methods rnf :: BatchGetMetricDataQuery -> () #
Eq BatchGetMetricDataQuery Source #
Instance details Defined in Amazonka.SESV2.Types.BatchGetMetricDataQuery Methods (==) :: BatchGetMetricDataQuery -> BatchGetMetricDataQuery -> Bool # (/=) :: BatchGetMetricDataQuery -> BatchGetMetricDataQuery -> Bool #
Hashable BatchGetMetricDataQuery Source #
Instance details Defined in Amazonka.SESV2.Types.BatchGetMetricDataQuery Methods hashWithSalt :: Int -> BatchGetMetricDataQuery -> Int # hash :: BatchGetMetricDataQuery -> Int #
type Rep BatchGetMetricDataQuery Source #
Instance details Defined in Amazonka.SESV2.Types.BatchGetMetricDataQuery type Rep BatchGetMetricDataQuery = D1 ('MetaData "BatchGetMetricDataQuery" "Amazonka.SESV2.Types.BatchGetMetricDataQuery" "amazonka-sesv2-2.0-KPRo1S1CRfP4bs5VKSgHvB" 'False) (C1 ('MetaCons "BatchGetMetricDataQuery'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "dimensions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap MetricDimensionName Text))) :: (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "namespace") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 MetricNamespace))) :: (S1 ('MetaSel ('Just "metric") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Metric) :: (S1 ('MetaSel ('Just "startDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX) :*: S1 ('MetaSel ('Just "endDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX)))))

newBatchGetMetricDataQuery Source #

Arguments

:: Text	`$sel:id:BatchGetMetricDataQuery'`
-> MetricNamespace	`$sel:namespace:BatchGetMetricDataQuery'`
-> Metric	`$sel:metric:BatchGetMetricDataQuery'`
-> UTCTime	`$sel:startDate:BatchGetMetricDataQuery'`
-> UTCTime	`$sel:endDate:BatchGetMetricDataQuery'`
-> BatchGetMetricDataQuery

Create a value of BatchGetMetricDataQuery with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:dimensions:BatchGetMetricDataQuery', batchGetMetricDataQuery_dimensions - An object that contains mapping between MetricDimensionName and MetricDimensionValue to filter metrics by.

$sel:id:BatchGetMetricDataQuery', batchGetMetricDataQuery_id - The query identifier.

$sel:namespace:BatchGetMetricDataQuery', batchGetMetricDataQuery_namespace - The query namespace - e.g. VDM

$sel:metric:BatchGetMetricDataQuery', batchGetMetricDataQuery_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.

$sel:startDate:BatchGetMetricDataQuery', batchGetMetricDataQuery_startDate - Represents the start date for the query interval.

$sel:endDate:BatchGetMetricDataQuery', batchGetMetricDataQuery_endDate - Represents the end date for the query interval.

batchGetMetricDataQuery_dimensions :: Lens' BatchGetMetricDataQuery (Maybe (HashMap MetricDimensionName Text)) Source #

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

batchGetMetricDataQuery_id :: Lens' BatchGetMetricDataQuery Text Source #

The query identifier.

batchGetMetricDataQuery_namespace :: Lens' BatchGetMetricDataQuery MetricNamespace Source #

The query namespace - e.g. VDM

batchGetMetricDataQuery_metric :: Lens' BatchGetMetricDataQuery Metric Source #

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.

batchGetMetricDataQuery_startDate :: Lens' BatchGetMetricDataQuery UTCTime Source #

Represents the start date for the query interval.

batchGetMetricDataQuery_endDate :: Lens' BatchGetMetricDataQuery UTCTime Source #

Represents the end date for the query interval.