{-# LANGUAGE DeriveGeneric #-}
{-# LANGUAGE DuplicateRecordFields #-}
{-# LANGUAGE NamedFieldPuns #-}
{-# LANGUAGE OverloadedStrings #-}
{-# LANGUAGE RecordWildCards #-}
{-# LANGUAGE StrictData #-}
{-# LANGUAGE NoImplicitPrelude #-}
{-# OPTIONS_GHC -fno-warn-unused-imports #-}
{-# OPTIONS_GHC -fno-warn-unused-matches #-}

-- Derived from AWS service descriptions, licensed under Apache 2.0.

-- |
-- Module      : Amazonka.CloudWatch.Types.MetricStreamStatisticsConfiguration
-- Copyright   : (c) 2013-2023 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
module Amazonka.CloudWatch.Types.MetricStreamStatisticsConfiguration where

import Amazonka.CloudWatch.Types.MetricStreamStatisticsMetric
import qualified Amazonka.Core as Core
import qualified Amazonka.Core.Lens.Internal as Lens
import qualified Amazonka.Data as Data
import qualified Amazonka.Prelude as Prelude

-- | By default, a metric stream always sends the @MAX@, @MIN@, @SUM@, and
-- @SAMPLECOUNT@ statistics for each metric that is streamed. This
-- structure contains information for one metric that includes additional
-- statistics in the stream. For more information about statistics, see
-- CloudWatch, listed in
-- <https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Statistics-definitions.html.html CloudWatch statistics definitions>.
--
-- /See:/ 'newMetricStreamStatisticsConfiguration' smart constructor.
data MetricStreamStatisticsConfiguration = MetricStreamStatisticsConfiguration'
  { -- | An array of metric name and namespace pairs that stream the additional
    -- statistics listed in the value of the @AdditionalStatistics@ parameter.
    -- There can be as many as 100 pairs in the array.
    --
    -- All metrics that match the combination of metric name and namespace will
    -- be streamed with the additional statistics, no matter their dimensions.
    MetricStreamStatisticsConfiguration
-> [MetricStreamStatisticsMetric]
includeMetrics :: [MetricStreamStatisticsMetric],
    -- | The list of additional statistics that are to be streamed for the
    -- metrics listed in the @IncludeMetrics@ array in this structure. This
    -- list can include as many as 20 statistics.
    --
    -- If the @OutputFormat@ for the stream is @opentelemetry0.7@, the only
    -- valid values are @p@/@??@/@ @ percentile statistics such as @p90@, @p99@
    -- and so on.
    --
    -- If the @OutputFormat@ for the stream is @json@, the valid values include
    -- the abbreviations for all of the statistics listed in
    -- <https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Statistics-definitions.html.html CloudWatch statistics definitions>.
    -- For example, this includes @tm98, @ @wm90@, @PR(:300)@, and so on.
    MetricStreamStatisticsConfiguration -> [Text]
additionalStatistics :: [Prelude.Text]
  }
  deriving (MetricStreamStatisticsConfiguration
-> MetricStreamStatisticsConfiguration -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: MetricStreamStatisticsConfiguration
-> MetricStreamStatisticsConfiguration -> Bool
$c/= :: MetricStreamStatisticsConfiguration
-> MetricStreamStatisticsConfiguration -> Bool
== :: MetricStreamStatisticsConfiguration
-> MetricStreamStatisticsConfiguration -> Bool
$c== :: MetricStreamStatisticsConfiguration
-> MetricStreamStatisticsConfiguration -> Bool
Prelude.Eq, ReadPrec [MetricStreamStatisticsConfiguration]
ReadPrec MetricStreamStatisticsConfiguration
Int -> ReadS MetricStreamStatisticsConfiguration
ReadS [MetricStreamStatisticsConfiguration]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [MetricStreamStatisticsConfiguration]
$creadListPrec :: ReadPrec [MetricStreamStatisticsConfiguration]
readPrec :: ReadPrec MetricStreamStatisticsConfiguration
$creadPrec :: ReadPrec MetricStreamStatisticsConfiguration
readList :: ReadS [MetricStreamStatisticsConfiguration]
$creadList :: ReadS [MetricStreamStatisticsConfiguration]
readsPrec :: Int -> ReadS MetricStreamStatisticsConfiguration
$creadsPrec :: Int -> ReadS MetricStreamStatisticsConfiguration
Prelude.Read, Int -> MetricStreamStatisticsConfiguration -> ShowS
[MetricStreamStatisticsConfiguration] -> ShowS
MetricStreamStatisticsConfiguration -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [MetricStreamStatisticsConfiguration] -> ShowS
$cshowList :: [MetricStreamStatisticsConfiguration] -> ShowS
show :: MetricStreamStatisticsConfiguration -> String
$cshow :: MetricStreamStatisticsConfiguration -> String
showsPrec :: Int -> MetricStreamStatisticsConfiguration -> ShowS
$cshowsPrec :: Int -> MetricStreamStatisticsConfiguration -> ShowS
Prelude.Show, forall x.
Rep MetricStreamStatisticsConfiguration x
-> MetricStreamStatisticsConfiguration
forall x.
MetricStreamStatisticsConfiguration
-> Rep MetricStreamStatisticsConfiguration x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x.
Rep MetricStreamStatisticsConfiguration x
-> MetricStreamStatisticsConfiguration
$cfrom :: forall x.
MetricStreamStatisticsConfiguration
-> Rep MetricStreamStatisticsConfiguration x
Prelude.Generic)

-- |
-- Create a value of 'MetricStreamStatisticsConfiguration' with all optional fields omitted.
--
-- Use <https://hackage.haskell.org/package/generic-lens generic-lens> or <https://hackage.haskell.org/package/optics optics> to modify other optional fields.
--
-- The following record fields are available, with the corresponding lenses provided
-- for backwards compatibility:
--
-- 'includeMetrics', 'metricStreamStatisticsConfiguration_includeMetrics' - An array of metric name and namespace pairs that stream the additional
-- statistics listed in the value of the @AdditionalStatistics@ parameter.
-- There can be as many as 100 pairs in the array.
--
-- All metrics that match the combination of metric name and namespace will
-- be streamed with the additional statistics, no matter their dimensions.
--
-- 'additionalStatistics', 'metricStreamStatisticsConfiguration_additionalStatistics' - The list of additional statistics that are to be streamed for the
-- metrics listed in the @IncludeMetrics@ array in this structure. This
-- list can include as many as 20 statistics.
--
-- If the @OutputFormat@ for the stream is @opentelemetry0.7@, the only
-- valid values are @p@/@??@/@ @ percentile statistics such as @p90@, @p99@
-- and so on.
--
-- If the @OutputFormat@ for the stream is @json@, the valid values include
-- the abbreviations for all of the statistics listed in
-- <https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Statistics-definitions.html.html CloudWatch statistics definitions>.
-- For example, this includes @tm98, @ @wm90@, @PR(:300)@, and so on.
newMetricStreamStatisticsConfiguration ::
  MetricStreamStatisticsConfiguration
newMetricStreamStatisticsConfiguration :: MetricStreamStatisticsConfiguration
newMetricStreamStatisticsConfiguration =
  MetricStreamStatisticsConfiguration'
    { $sel:includeMetrics:MetricStreamStatisticsConfiguration' :: [MetricStreamStatisticsMetric]
includeMetrics =
        forall a. Monoid a => a
Prelude.mempty,
      $sel:additionalStatistics:MetricStreamStatisticsConfiguration' :: [Text]
additionalStatistics = forall a. Monoid a => a
Prelude.mempty
    }

-- | An array of metric name and namespace pairs that stream the additional
-- statistics listed in the value of the @AdditionalStatistics@ parameter.
-- There can be as many as 100 pairs in the array.
--
-- All metrics that match the combination of metric name and namespace will
-- be streamed with the additional statistics, no matter their dimensions.
metricStreamStatisticsConfiguration_includeMetrics :: Lens.Lens' MetricStreamStatisticsConfiguration [MetricStreamStatisticsMetric]
metricStreamStatisticsConfiguration_includeMetrics :: Lens'
  MetricStreamStatisticsConfiguration [MetricStreamStatisticsMetric]
metricStreamStatisticsConfiguration_includeMetrics = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\MetricStreamStatisticsConfiguration' {[MetricStreamStatisticsMetric]
includeMetrics :: [MetricStreamStatisticsMetric]
$sel:includeMetrics:MetricStreamStatisticsConfiguration' :: MetricStreamStatisticsConfiguration
-> [MetricStreamStatisticsMetric]
includeMetrics} -> [MetricStreamStatisticsMetric]
includeMetrics) (\s :: MetricStreamStatisticsConfiguration
s@MetricStreamStatisticsConfiguration' {} [MetricStreamStatisticsMetric]
a -> MetricStreamStatisticsConfiguration
s {$sel:includeMetrics:MetricStreamStatisticsConfiguration' :: [MetricStreamStatisticsMetric]
includeMetrics = [MetricStreamStatisticsMetric]
a} :: MetricStreamStatisticsConfiguration) forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall s t a b. (Coercible s a, Coercible t b) => Iso s t a b
Lens.coerced

-- | The list of additional statistics that are to be streamed for the
-- metrics listed in the @IncludeMetrics@ array in this structure. This
-- list can include as many as 20 statistics.
--
-- If the @OutputFormat@ for the stream is @opentelemetry0.7@, the only
-- valid values are @p@/@??@/@ @ percentile statistics such as @p90@, @p99@
-- and so on.
--
-- If the @OutputFormat@ for the stream is @json@, the valid values include
-- the abbreviations for all of the statistics listed in
-- <https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Statistics-definitions.html.html CloudWatch statistics definitions>.
-- For example, this includes @tm98, @ @wm90@, @PR(:300)@, and so on.
metricStreamStatisticsConfiguration_additionalStatistics :: Lens.Lens' MetricStreamStatisticsConfiguration [Prelude.Text]
metricStreamStatisticsConfiguration_additionalStatistics :: Lens' MetricStreamStatisticsConfiguration [Text]
metricStreamStatisticsConfiguration_additionalStatistics = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\MetricStreamStatisticsConfiguration' {[Text]
additionalStatistics :: [Text]
$sel:additionalStatistics:MetricStreamStatisticsConfiguration' :: MetricStreamStatisticsConfiguration -> [Text]
additionalStatistics} -> [Text]
additionalStatistics) (\s :: MetricStreamStatisticsConfiguration
s@MetricStreamStatisticsConfiguration' {} [Text]
a -> MetricStreamStatisticsConfiguration
s {$sel:additionalStatistics:MetricStreamStatisticsConfiguration' :: [Text]
additionalStatistics = [Text]
a} :: MetricStreamStatisticsConfiguration) forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall s t a b. (Coercible s a, Coercible t b) => Iso s t a b
Lens.coerced

instance
  Data.FromXML
    MetricStreamStatisticsConfiguration
  where
  parseXML :: [Node] -> Either String MetricStreamStatisticsConfiguration
parseXML [Node]
x =
    [MetricStreamStatisticsMetric]
-> [Text] -> MetricStreamStatisticsConfiguration
MetricStreamStatisticsConfiguration'
      forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> ( [Node]
x
                      forall a. FromXML a => [Node] -> Text -> Either String (Maybe a)
Data..@? Text
"IncludeMetrics"
                      forall (f :: * -> *) a. Functor f => f (Maybe a) -> a -> f a
Core..!@ forall a. Monoid a => a
Prelude.mempty
                      forall (m :: * -> *) a b. Monad m => m a -> (a -> m b) -> m b
Prelude.>>= forall a. FromXML a => Text -> [Node] -> Either String [a]
Data.parseXMLList Text
"member"
                  )
      forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> ( [Node]
x
                      forall a. FromXML a => [Node] -> Text -> Either String (Maybe a)
Data..@? Text
"AdditionalStatistics"
                      forall (f :: * -> *) a. Functor f => f (Maybe a) -> a -> f a
Core..!@ forall a. Monoid a => a
Prelude.mempty
                      forall (m :: * -> *) a b. Monad m => m a -> (a -> m b) -> m b
Prelude.>>= forall a. FromXML a => Text -> [Node] -> Either String [a]
Data.parseXMLList Text
"member"
                  )

instance
  Prelude.Hashable
    MetricStreamStatisticsConfiguration
  where
  hashWithSalt :: Int -> MetricStreamStatisticsConfiguration -> Int
hashWithSalt
    Int
_salt
    MetricStreamStatisticsConfiguration' {[Text]
[MetricStreamStatisticsMetric]
additionalStatistics :: [Text]
includeMetrics :: [MetricStreamStatisticsMetric]
$sel:additionalStatistics:MetricStreamStatisticsConfiguration' :: MetricStreamStatisticsConfiguration -> [Text]
$sel:includeMetrics:MetricStreamStatisticsConfiguration' :: MetricStreamStatisticsConfiguration
-> [MetricStreamStatisticsMetric]
..} =
      Int
_salt
        forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` [MetricStreamStatisticsMetric]
includeMetrics
        forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` [Text]
additionalStatistics

instance
  Prelude.NFData
    MetricStreamStatisticsConfiguration
  where
  rnf :: MetricStreamStatisticsConfiguration -> ()
rnf MetricStreamStatisticsConfiguration' {[Text]
[MetricStreamStatisticsMetric]
additionalStatistics :: [Text]
includeMetrics :: [MetricStreamStatisticsMetric]
$sel:additionalStatistics:MetricStreamStatisticsConfiguration' :: MetricStreamStatisticsConfiguration -> [Text]
$sel:includeMetrics:MetricStreamStatisticsConfiguration' :: MetricStreamStatisticsConfiguration
-> [MetricStreamStatisticsMetric]
..} =
    forall a. NFData a => a -> ()
Prelude.rnf [MetricStreamStatisticsMetric]
includeMetrics
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf [Text]
additionalStatistics

instance
  Data.ToQuery
    MetricStreamStatisticsConfiguration
  where
  toQuery :: MetricStreamStatisticsConfiguration -> QueryString
toQuery MetricStreamStatisticsConfiguration' {[Text]
[MetricStreamStatisticsMetric]
additionalStatistics :: [Text]
includeMetrics :: [MetricStreamStatisticsMetric]
$sel:additionalStatistics:MetricStreamStatisticsConfiguration' :: MetricStreamStatisticsConfiguration -> [Text]
$sel:includeMetrics:MetricStreamStatisticsConfiguration' :: MetricStreamStatisticsConfiguration
-> [MetricStreamStatisticsMetric]
..} =
    forall a. Monoid a => [a] -> a
Prelude.mconcat
      [ ByteString
"IncludeMetrics"
          forall a. ToQuery a => ByteString -> a -> QueryString
Data.=: forall a.
(IsList a, ToQuery (Item a)) =>
ByteString -> a -> QueryString
Data.toQueryList ByteString
"member" [MetricStreamStatisticsMetric]
includeMetrics,
        ByteString
"AdditionalStatistics"
          forall a. ToQuery a => ByteString -> a -> QueryString
Data.=: forall a.
(IsList a, ToQuery (Item a)) =>
ByteString -> a -> QueryString
Data.toQueryList ByteString
"member" [Text]
additionalStatistics
      ]