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

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

-- |
-- Module      : Amazonka.Kinesis.EnableEnhancedMonitoring
-- Copyright   : (c) 2013-2023 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
--
-- Enables enhanced Kinesis data stream monitoring for shard-level metrics.
--
-- When invoking this API, it is recommended you use the @StreamARN@ input
-- parameter rather than the @StreamName@ input parameter.
module Amazonka.Kinesis.EnableEnhancedMonitoring
  ( -- * Creating a Request
    EnableEnhancedMonitoring (..),
    newEnableEnhancedMonitoring,

    -- * Request Lenses
    enableEnhancedMonitoring_streamARN,
    enableEnhancedMonitoring_streamName,
    enableEnhancedMonitoring_shardLevelMetrics,

    -- * Destructuring the Response
    EnhancedMonitoringOutput (..),
    newEnhancedMonitoringOutput,

    -- * Response Lenses
    enhancedMonitoringOutput_currentShardLevelMetrics,
    enhancedMonitoringOutput_desiredShardLevelMetrics,
    enhancedMonitoringOutput_streamARN,
    enhancedMonitoringOutput_streamName,
  )
where

import qualified Amazonka.Core as Core
import qualified Amazonka.Core.Lens.Internal as Lens
import qualified Amazonka.Data as Data
import Amazonka.Kinesis.Types
import qualified Amazonka.Prelude as Prelude
import qualified Amazonka.Request as Request
import qualified Amazonka.Response as Response

-- | Represents the input for EnableEnhancedMonitoring.
--
-- /See:/ 'newEnableEnhancedMonitoring' smart constructor.
data EnableEnhancedMonitoring = EnableEnhancedMonitoring'
  { -- | The ARN of the stream.
    EnableEnhancedMonitoring -> Maybe Text
streamARN :: Prelude.Maybe Prelude.Text,
    -- | The name of the stream for which to enable enhanced monitoring.
    EnableEnhancedMonitoring -> Maybe Text
streamName :: Prelude.Maybe Prelude.Text,
    -- | List of shard-level metrics to enable.
    --
    -- The following are the valid shard-level metrics. The value \"@ALL@\"
    -- enables every metric.
    --
    -- -   @IncomingBytes@
    --
    -- -   @IncomingRecords@
    --
    -- -   @OutgoingBytes@
    --
    -- -   @OutgoingRecords@
    --
    -- -   @WriteProvisionedThroughputExceeded@
    --
    -- -   @ReadProvisionedThroughputExceeded@
    --
    -- -   @IteratorAgeMilliseconds@
    --
    -- -   @ALL@
    --
    -- For more information, see
    -- <https://docs.aws.amazon.com/kinesis/latest/dev/monitoring-with-cloudwatch.html Monitoring the Amazon Kinesis Data Streams Service with Amazon CloudWatch>
    -- in the /Amazon Kinesis Data Streams Developer Guide/.
    EnableEnhancedMonitoring -> [MetricsName]
shardLevelMetrics :: [MetricsName]
  }
  deriving (EnableEnhancedMonitoring -> EnableEnhancedMonitoring -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: EnableEnhancedMonitoring -> EnableEnhancedMonitoring -> Bool
$c/= :: EnableEnhancedMonitoring -> EnableEnhancedMonitoring -> Bool
== :: EnableEnhancedMonitoring -> EnableEnhancedMonitoring -> Bool
$c== :: EnableEnhancedMonitoring -> EnableEnhancedMonitoring -> Bool
Prelude.Eq, ReadPrec [EnableEnhancedMonitoring]
ReadPrec EnableEnhancedMonitoring
Int -> ReadS EnableEnhancedMonitoring
ReadS [EnableEnhancedMonitoring]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [EnableEnhancedMonitoring]
$creadListPrec :: ReadPrec [EnableEnhancedMonitoring]
readPrec :: ReadPrec EnableEnhancedMonitoring
$creadPrec :: ReadPrec EnableEnhancedMonitoring
readList :: ReadS [EnableEnhancedMonitoring]
$creadList :: ReadS [EnableEnhancedMonitoring]
readsPrec :: Int -> ReadS EnableEnhancedMonitoring
$creadsPrec :: Int -> ReadS EnableEnhancedMonitoring
Prelude.Read, Int -> EnableEnhancedMonitoring -> ShowS
[EnableEnhancedMonitoring] -> ShowS
EnableEnhancedMonitoring -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [EnableEnhancedMonitoring] -> ShowS
$cshowList :: [EnableEnhancedMonitoring] -> ShowS
show :: EnableEnhancedMonitoring -> String
$cshow :: EnableEnhancedMonitoring -> String
showsPrec :: Int -> EnableEnhancedMonitoring -> ShowS
$cshowsPrec :: Int -> EnableEnhancedMonitoring -> ShowS
Prelude.Show, forall x.
Rep EnableEnhancedMonitoring x -> EnableEnhancedMonitoring
forall x.
EnableEnhancedMonitoring -> Rep EnableEnhancedMonitoring x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x.
Rep EnableEnhancedMonitoring x -> EnableEnhancedMonitoring
$cfrom :: forall x.
EnableEnhancedMonitoring -> Rep EnableEnhancedMonitoring x
Prelude.Generic)

-- |
-- Create a value of 'EnableEnhancedMonitoring' 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:
--
-- 'streamARN', 'enableEnhancedMonitoring_streamARN' - The ARN of the stream.
--
-- 'streamName', 'enableEnhancedMonitoring_streamName' - The name of the stream for which to enable enhanced monitoring.
--
-- 'shardLevelMetrics', 'enableEnhancedMonitoring_shardLevelMetrics' - List of shard-level metrics to enable.
--
-- The following are the valid shard-level metrics. The value \"@ALL@\"
-- enables every metric.
--
-- -   @IncomingBytes@
--
-- -   @IncomingRecords@
--
-- -   @OutgoingBytes@
--
-- -   @OutgoingRecords@
--
-- -   @WriteProvisionedThroughputExceeded@
--
-- -   @ReadProvisionedThroughputExceeded@
--
-- -   @IteratorAgeMilliseconds@
--
-- -   @ALL@
--
-- For more information, see
-- <https://docs.aws.amazon.com/kinesis/latest/dev/monitoring-with-cloudwatch.html Monitoring the Amazon Kinesis Data Streams Service with Amazon CloudWatch>
-- in the /Amazon Kinesis Data Streams Developer Guide/.
newEnableEnhancedMonitoring ::
  EnableEnhancedMonitoring
newEnableEnhancedMonitoring :: EnableEnhancedMonitoring
newEnableEnhancedMonitoring =
  EnableEnhancedMonitoring'
    { $sel:streamARN:EnableEnhancedMonitoring' :: Maybe Text
streamARN =
        forall a. Maybe a
Prelude.Nothing,
      $sel:streamName:EnableEnhancedMonitoring' :: Maybe Text
streamName = forall a. Maybe a
Prelude.Nothing,
      $sel:shardLevelMetrics:EnableEnhancedMonitoring' :: [MetricsName]
shardLevelMetrics = forall a. Monoid a => a
Prelude.mempty
    }

-- | The ARN of the stream.
enableEnhancedMonitoring_streamARN :: Lens.Lens' EnableEnhancedMonitoring (Prelude.Maybe Prelude.Text)
enableEnhancedMonitoring_streamARN :: Lens' EnableEnhancedMonitoring (Maybe Text)
enableEnhancedMonitoring_streamARN = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\EnableEnhancedMonitoring' {Maybe Text
streamARN :: Maybe Text
$sel:streamARN:EnableEnhancedMonitoring' :: EnableEnhancedMonitoring -> Maybe Text
streamARN} -> Maybe Text
streamARN) (\s :: EnableEnhancedMonitoring
s@EnableEnhancedMonitoring' {} Maybe Text
a -> EnableEnhancedMonitoring
s {$sel:streamARN:EnableEnhancedMonitoring' :: Maybe Text
streamARN = Maybe Text
a} :: EnableEnhancedMonitoring)

-- | The name of the stream for which to enable enhanced monitoring.
enableEnhancedMonitoring_streamName :: Lens.Lens' EnableEnhancedMonitoring (Prelude.Maybe Prelude.Text)
enableEnhancedMonitoring_streamName :: Lens' EnableEnhancedMonitoring (Maybe Text)
enableEnhancedMonitoring_streamName = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\EnableEnhancedMonitoring' {Maybe Text
streamName :: Maybe Text
$sel:streamName:EnableEnhancedMonitoring' :: EnableEnhancedMonitoring -> Maybe Text
streamName} -> Maybe Text
streamName) (\s :: EnableEnhancedMonitoring
s@EnableEnhancedMonitoring' {} Maybe Text
a -> EnableEnhancedMonitoring
s {$sel:streamName:EnableEnhancedMonitoring' :: Maybe Text
streamName = Maybe Text
a} :: EnableEnhancedMonitoring)

-- | List of shard-level metrics to enable.
--
-- The following are the valid shard-level metrics. The value \"@ALL@\"
-- enables every metric.
--
-- -   @IncomingBytes@
--
-- -   @IncomingRecords@
--
-- -   @OutgoingBytes@
--
-- -   @OutgoingRecords@
--
-- -   @WriteProvisionedThroughputExceeded@
--
-- -   @ReadProvisionedThroughputExceeded@
--
-- -   @IteratorAgeMilliseconds@
--
-- -   @ALL@
--
-- For more information, see
-- <https://docs.aws.amazon.com/kinesis/latest/dev/monitoring-with-cloudwatch.html Monitoring the Amazon Kinesis Data Streams Service with Amazon CloudWatch>
-- in the /Amazon Kinesis Data Streams Developer Guide/.
enableEnhancedMonitoring_shardLevelMetrics :: Lens.Lens' EnableEnhancedMonitoring [MetricsName]
enableEnhancedMonitoring_shardLevelMetrics :: Lens' EnableEnhancedMonitoring [MetricsName]
enableEnhancedMonitoring_shardLevelMetrics = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\EnableEnhancedMonitoring' {[MetricsName]
shardLevelMetrics :: [MetricsName]
$sel:shardLevelMetrics:EnableEnhancedMonitoring' :: EnableEnhancedMonitoring -> [MetricsName]
shardLevelMetrics} -> [MetricsName]
shardLevelMetrics) (\s :: EnableEnhancedMonitoring
s@EnableEnhancedMonitoring' {} [MetricsName]
a -> EnableEnhancedMonitoring
s {$sel:shardLevelMetrics:EnableEnhancedMonitoring' :: [MetricsName]
shardLevelMetrics = [MetricsName]
a} :: EnableEnhancedMonitoring) 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 Core.AWSRequest EnableEnhancedMonitoring where
  type
    AWSResponse EnableEnhancedMonitoring =
      EnhancedMonitoringOutput
  request :: (Service -> Service)
-> EnableEnhancedMonitoring -> Request EnableEnhancedMonitoring
request Service -> Service
overrides =
    forall a. (ToRequest a, ToJSON a) => Service -> a -> Request a
Request.postJSON (Service -> Service
overrides Service
defaultService)
  response :: forall (m :: * -> *).
MonadResource m =>
(ByteStringLazy -> IO ByteStringLazy)
-> Service
-> Proxy EnableEnhancedMonitoring
-> ClientResponse ClientBody
-> m (Either
        Error (ClientResponse (AWSResponse EnableEnhancedMonitoring)))
response =
    forall (m :: * -> *) a.
MonadResource m =>
(Int -> ResponseHeaders -> Object -> Either String (AWSResponse a))
-> (ByteStringLazy -> IO ByteStringLazy)
-> Service
-> Proxy a
-> ClientResponse ClientBody
-> m (Either Error (ClientResponse (AWSResponse a)))
Response.receiveJSON
      (\Int
s ResponseHeaders
h Object
x -> forall a. FromJSON a => Object -> Either String a
Data.eitherParseJSON Object
x)

instance Prelude.Hashable EnableEnhancedMonitoring where
  hashWithSalt :: Int -> EnableEnhancedMonitoring -> Int
hashWithSalt Int
_salt EnableEnhancedMonitoring' {[MetricsName]
Maybe Text
shardLevelMetrics :: [MetricsName]
streamName :: Maybe Text
streamARN :: Maybe Text
$sel:shardLevelMetrics:EnableEnhancedMonitoring' :: EnableEnhancedMonitoring -> [MetricsName]
$sel:streamName:EnableEnhancedMonitoring' :: EnableEnhancedMonitoring -> Maybe Text
$sel:streamARN:EnableEnhancedMonitoring' :: EnableEnhancedMonitoring -> Maybe Text
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
streamARN
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
streamName
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` [MetricsName]
shardLevelMetrics

instance Prelude.NFData EnableEnhancedMonitoring where
  rnf :: EnableEnhancedMonitoring -> ()
rnf EnableEnhancedMonitoring' {[MetricsName]
Maybe Text
shardLevelMetrics :: [MetricsName]
streamName :: Maybe Text
streamARN :: Maybe Text
$sel:shardLevelMetrics:EnableEnhancedMonitoring' :: EnableEnhancedMonitoring -> [MetricsName]
$sel:streamName:EnableEnhancedMonitoring' :: EnableEnhancedMonitoring -> Maybe Text
$sel:streamARN:EnableEnhancedMonitoring' :: EnableEnhancedMonitoring -> Maybe Text
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
streamARN
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
streamName
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf [MetricsName]
shardLevelMetrics

instance Data.ToHeaders EnableEnhancedMonitoring where
  toHeaders :: EnableEnhancedMonitoring -> ResponseHeaders
toHeaders =
    forall a b. a -> b -> a
Prelude.const
      ( forall a. Monoid a => [a] -> a
Prelude.mconcat
          [ HeaderName
"X-Amz-Target"
              forall a. ToHeader a => HeaderName -> a -> ResponseHeaders
Data.=# ( ByteString
"Kinesis_20131202.EnableEnhancedMonitoring" ::
                          Prelude.ByteString
                      ),
            HeaderName
"Content-Type"
              forall a. ToHeader a => HeaderName -> a -> ResponseHeaders
Data.=# ( ByteString
"application/x-amz-json-1.1" ::
                          Prelude.ByteString
                      )
          ]
      )

instance Data.ToJSON EnableEnhancedMonitoring where
  toJSON :: EnableEnhancedMonitoring -> Value
toJSON EnableEnhancedMonitoring' {[MetricsName]
Maybe Text
shardLevelMetrics :: [MetricsName]
streamName :: Maybe Text
streamARN :: Maybe Text
$sel:shardLevelMetrics:EnableEnhancedMonitoring' :: EnableEnhancedMonitoring -> [MetricsName]
$sel:streamName:EnableEnhancedMonitoring' :: EnableEnhancedMonitoring -> Maybe Text
$sel:streamARN:EnableEnhancedMonitoring' :: EnableEnhancedMonitoring -> Maybe Text
..} =
    [Pair] -> Value
Data.object
      ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ (Key
"StreamARN" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=) forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe Text
streamARN,
            (Key
"StreamName" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=) forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe Text
streamName,
            forall a. a -> Maybe a
Prelude.Just
              (Key
"ShardLevelMetrics" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= [MetricsName]
shardLevelMetrics)
          ]
      )

instance Data.ToPath EnableEnhancedMonitoring where
  toPath :: EnableEnhancedMonitoring -> ByteString
toPath = forall a b. a -> b -> a
Prelude.const ByteString
"/"

instance Data.ToQuery EnableEnhancedMonitoring where
  toQuery :: EnableEnhancedMonitoring -> QueryString
toQuery = forall a b. a -> b -> a
Prelude.const forall a. Monoid a => a
Prelude.mempty