{-# 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.CloudWatch.DescribeInsightRules
-- Copyright   : (c) 2013-2023 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
--
-- Returns a list of all the Contributor Insights rules in your account.
--
-- For more information about Contributor Insights, see
-- <https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/ContributorInsights.html Using Contributor Insights to Analyze High-Cardinality Data>.
module Amazonka.CloudWatch.DescribeInsightRules
  ( -- * Creating a Request
    DescribeInsightRules (..),
    newDescribeInsightRules,

    -- * Request Lenses
    describeInsightRules_maxResults,
    describeInsightRules_nextToken,

    -- * Destructuring the Response
    DescribeInsightRulesResponse (..),
    newDescribeInsightRulesResponse,

    -- * Response Lenses
    describeInsightRulesResponse_insightRules,
    describeInsightRulesResponse_nextToken,
    describeInsightRulesResponse_httpStatus,
  )
where

import Amazonka.CloudWatch.Types
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
import qualified Amazonka.Request as Request
import qualified Amazonka.Response as Response

-- | /See:/ 'newDescribeInsightRules' smart constructor.
data DescribeInsightRules = DescribeInsightRules'
  { -- | The maximum number of results to return in one operation. If you omit
    -- this parameter, the default of 500 is used.
    DescribeInsightRules -> Maybe Natural
maxResults :: Prelude.Maybe Prelude.Natural,
    -- | Include this value, if it was returned by the previous operation, to get
    -- the next set of rules.
    DescribeInsightRules -> Maybe Text
nextToken :: Prelude.Maybe Prelude.Text
  }
  deriving (DescribeInsightRules -> DescribeInsightRules -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: DescribeInsightRules -> DescribeInsightRules -> Bool
$c/= :: DescribeInsightRules -> DescribeInsightRules -> Bool
== :: DescribeInsightRules -> DescribeInsightRules -> Bool
$c== :: DescribeInsightRules -> DescribeInsightRules -> Bool
Prelude.Eq, ReadPrec [DescribeInsightRules]
ReadPrec DescribeInsightRules
Int -> ReadS DescribeInsightRules
ReadS [DescribeInsightRules]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [DescribeInsightRules]
$creadListPrec :: ReadPrec [DescribeInsightRules]
readPrec :: ReadPrec DescribeInsightRules
$creadPrec :: ReadPrec DescribeInsightRules
readList :: ReadS [DescribeInsightRules]
$creadList :: ReadS [DescribeInsightRules]
readsPrec :: Int -> ReadS DescribeInsightRules
$creadsPrec :: Int -> ReadS DescribeInsightRules
Prelude.Read, Int -> DescribeInsightRules -> ShowS
[DescribeInsightRules] -> ShowS
DescribeInsightRules -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [DescribeInsightRules] -> ShowS
$cshowList :: [DescribeInsightRules] -> ShowS
show :: DescribeInsightRules -> String
$cshow :: DescribeInsightRules -> String
showsPrec :: Int -> DescribeInsightRules -> ShowS
$cshowsPrec :: Int -> DescribeInsightRules -> ShowS
Prelude.Show, forall x. Rep DescribeInsightRules x -> DescribeInsightRules
forall x. DescribeInsightRules -> Rep DescribeInsightRules x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep DescribeInsightRules x -> DescribeInsightRules
$cfrom :: forall x. DescribeInsightRules -> Rep DescribeInsightRules x
Prelude.Generic)

-- |
-- Create a value of 'DescribeInsightRules' 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:
--
-- 'maxResults', 'describeInsightRules_maxResults' - The maximum number of results to return in one operation. If you omit
-- this parameter, the default of 500 is used.
--
-- 'nextToken', 'describeInsightRules_nextToken' - Include this value, if it was returned by the previous operation, to get
-- the next set of rules.
newDescribeInsightRules ::
  DescribeInsightRules
newDescribeInsightRules :: DescribeInsightRules
newDescribeInsightRules =
  DescribeInsightRules'
    { $sel:maxResults:DescribeInsightRules' :: Maybe Natural
maxResults = forall a. Maybe a
Prelude.Nothing,
      $sel:nextToken:DescribeInsightRules' :: Maybe Text
nextToken = forall a. Maybe a
Prelude.Nothing
    }

-- | The maximum number of results to return in one operation. If you omit
-- this parameter, the default of 500 is used.
describeInsightRules_maxResults :: Lens.Lens' DescribeInsightRules (Prelude.Maybe Prelude.Natural)
describeInsightRules_maxResults :: Lens' DescribeInsightRules (Maybe Natural)
describeInsightRules_maxResults = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeInsightRules' {Maybe Natural
maxResults :: Maybe Natural
$sel:maxResults:DescribeInsightRules' :: DescribeInsightRules -> Maybe Natural
maxResults} -> Maybe Natural
maxResults) (\s :: DescribeInsightRules
s@DescribeInsightRules' {} Maybe Natural
a -> DescribeInsightRules
s {$sel:maxResults:DescribeInsightRules' :: Maybe Natural
maxResults = Maybe Natural
a} :: DescribeInsightRules)

-- | Include this value, if it was returned by the previous operation, to get
-- the next set of rules.
describeInsightRules_nextToken :: Lens.Lens' DescribeInsightRules (Prelude.Maybe Prelude.Text)
describeInsightRules_nextToken :: Lens' DescribeInsightRules (Maybe Text)
describeInsightRules_nextToken = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeInsightRules' {Maybe Text
nextToken :: Maybe Text
$sel:nextToken:DescribeInsightRules' :: DescribeInsightRules -> Maybe Text
nextToken} -> Maybe Text
nextToken) (\s :: DescribeInsightRules
s@DescribeInsightRules' {} Maybe Text
a -> DescribeInsightRules
s {$sel:nextToken:DescribeInsightRules' :: Maybe Text
nextToken = Maybe Text
a} :: DescribeInsightRules)

instance Core.AWSRequest DescribeInsightRules where
  type
    AWSResponse DescribeInsightRules =
      DescribeInsightRulesResponse
  request :: (Service -> Service)
-> DescribeInsightRules -> Request DescribeInsightRules
request Service -> Service
overrides =
    forall a. ToRequest a => Service -> a -> Request a
Request.postQuery (Service -> Service
overrides Service
defaultService)
  response :: forall (m :: * -> *).
MonadResource m =>
(ByteStringLazy -> IO ByteStringLazy)
-> Service
-> Proxy DescribeInsightRules
-> ClientResponse ClientBody
-> m (Either
        Error (ClientResponse (AWSResponse DescribeInsightRules)))
response =
    forall (m :: * -> *) a.
MonadResource m =>
Text
-> (Int
    -> ResponseHeaders -> [Node] -> Either String (AWSResponse a))
-> (ByteStringLazy -> IO ByteStringLazy)
-> Service
-> Proxy a
-> ClientResponse ClientBody
-> m (Either Error (ClientResponse (AWSResponse a)))
Response.receiveXMLWrapper
      Text
"DescribeInsightRulesResult"
      ( \Int
s ResponseHeaders
h [Node]
x ->
          Maybe [InsightRule]
-> Maybe Text -> Int -> DescribeInsightRulesResponse
DescribeInsightRulesResponse'
            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
"InsightRules"
                            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 (f :: * -> *) a b.
Applicative f =>
([a] -> f b) -> [a] -> f (Maybe b)
Core.may (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
"NextToken")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (forall (f :: * -> *) a. Applicative f => a -> f a
Prelude.pure (forall a. Enum a => a -> Int
Prelude.fromEnum Int
s))
      )

instance Prelude.Hashable DescribeInsightRules where
  hashWithSalt :: Int -> DescribeInsightRules -> Int
hashWithSalt Int
_salt DescribeInsightRules' {Maybe Natural
Maybe Text
nextToken :: Maybe Text
maxResults :: Maybe Natural
$sel:nextToken:DescribeInsightRules' :: DescribeInsightRules -> Maybe Text
$sel:maxResults:DescribeInsightRules' :: DescribeInsightRules -> Maybe Natural
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Natural
maxResults
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
nextToken

instance Prelude.NFData DescribeInsightRules where
  rnf :: DescribeInsightRules -> ()
rnf DescribeInsightRules' {Maybe Natural
Maybe Text
nextToken :: Maybe Text
maxResults :: Maybe Natural
$sel:nextToken:DescribeInsightRules' :: DescribeInsightRules -> Maybe Text
$sel:maxResults:DescribeInsightRules' :: DescribeInsightRules -> Maybe Natural
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe Natural
maxResults
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
nextToken

instance Data.ToHeaders DescribeInsightRules where
  toHeaders :: DescribeInsightRules -> ResponseHeaders
toHeaders = forall a b. a -> b -> a
Prelude.const forall a. Monoid a => a
Prelude.mempty

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

instance Data.ToQuery DescribeInsightRules where
  toQuery :: DescribeInsightRules -> QueryString
toQuery DescribeInsightRules' {Maybe Natural
Maybe Text
nextToken :: Maybe Text
maxResults :: Maybe Natural
$sel:nextToken:DescribeInsightRules' :: DescribeInsightRules -> Maybe Text
$sel:maxResults:DescribeInsightRules' :: DescribeInsightRules -> Maybe Natural
..} =
    forall a. Monoid a => [a] -> a
Prelude.mconcat
      [ ByteString
"Action"
          forall a. ToQuery a => ByteString -> a -> QueryString
Data.=: (ByteString
"DescribeInsightRules" :: Prelude.ByteString),
        ByteString
"Version"
          forall a. ToQuery a => ByteString -> a -> QueryString
Data.=: (ByteString
"2010-08-01" :: Prelude.ByteString),
        ByteString
"MaxResults" forall a. ToQuery a => ByteString -> a -> QueryString
Data.=: Maybe Natural
maxResults,
        ByteString
"NextToken" forall a. ToQuery a => ByteString -> a -> QueryString
Data.=: Maybe Text
nextToken
      ]

-- | /See:/ 'newDescribeInsightRulesResponse' smart constructor.
data DescribeInsightRulesResponse = DescribeInsightRulesResponse'
  { -- | The rules returned by the operation.
    DescribeInsightRulesResponse -> Maybe [InsightRule]
insightRules :: Prelude.Maybe [InsightRule],
    -- | If this parameter is present, it is a token that marks the start of the
    -- next batch of returned results.
    DescribeInsightRulesResponse -> Maybe Text
nextToken :: Prelude.Maybe Prelude.Text,
    -- | The response's http status code.
    DescribeInsightRulesResponse -> Int
httpStatus :: Prelude.Int
  }
  deriving (DescribeInsightRulesResponse
-> DescribeInsightRulesResponse -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: DescribeInsightRulesResponse
-> DescribeInsightRulesResponse -> Bool
$c/= :: DescribeInsightRulesResponse
-> DescribeInsightRulesResponse -> Bool
== :: DescribeInsightRulesResponse
-> DescribeInsightRulesResponse -> Bool
$c== :: DescribeInsightRulesResponse
-> DescribeInsightRulesResponse -> Bool
Prelude.Eq, ReadPrec [DescribeInsightRulesResponse]
ReadPrec DescribeInsightRulesResponse
Int -> ReadS DescribeInsightRulesResponse
ReadS [DescribeInsightRulesResponse]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [DescribeInsightRulesResponse]
$creadListPrec :: ReadPrec [DescribeInsightRulesResponse]
readPrec :: ReadPrec DescribeInsightRulesResponse
$creadPrec :: ReadPrec DescribeInsightRulesResponse
readList :: ReadS [DescribeInsightRulesResponse]
$creadList :: ReadS [DescribeInsightRulesResponse]
readsPrec :: Int -> ReadS DescribeInsightRulesResponse
$creadsPrec :: Int -> ReadS DescribeInsightRulesResponse
Prelude.Read, Int -> DescribeInsightRulesResponse -> ShowS
[DescribeInsightRulesResponse] -> ShowS
DescribeInsightRulesResponse -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [DescribeInsightRulesResponse] -> ShowS
$cshowList :: [DescribeInsightRulesResponse] -> ShowS
show :: DescribeInsightRulesResponse -> String
$cshow :: DescribeInsightRulesResponse -> String
showsPrec :: Int -> DescribeInsightRulesResponse -> ShowS
$cshowsPrec :: Int -> DescribeInsightRulesResponse -> ShowS
Prelude.Show, forall x.
Rep DescribeInsightRulesResponse x -> DescribeInsightRulesResponse
forall x.
DescribeInsightRulesResponse -> Rep DescribeInsightRulesResponse x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x.
Rep DescribeInsightRulesResponse x -> DescribeInsightRulesResponse
$cfrom :: forall x.
DescribeInsightRulesResponse -> Rep DescribeInsightRulesResponse x
Prelude.Generic)

-- |
-- Create a value of 'DescribeInsightRulesResponse' 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:
--
-- 'insightRules', 'describeInsightRulesResponse_insightRules' - The rules returned by the operation.
--
-- 'nextToken', 'describeInsightRulesResponse_nextToken' - If this parameter is present, it is a token that marks the start of the
-- next batch of returned results.
--
-- 'httpStatus', 'describeInsightRulesResponse_httpStatus' - The response's http status code.
newDescribeInsightRulesResponse ::
  -- | 'httpStatus'
  Prelude.Int ->
  DescribeInsightRulesResponse
newDescribeInsightRulesResponse :: Int -> DescribeInsightRulesResponse
newDescribeInsightRulesResponse Int
pHttpStatus_ =
  DescribeInsightRulesResponse'
    { $sel:insightRules:DescribeInsightRulesResponse' :: Maybe [InsightRule]
insightRules =
        forall a. Maybe a
Prelude.Nothing,
      $sel:nextToken:DescribeInsightRulesResponse' :: Maybe Text
nextToken = forall a. Maybe a
Prelude.Nothing,
      $sel:httpStatus:DescribeInsightRulesResponse' :: Int
httpStatus = Int
pHttpStatus_
    }

-- | The rules returned by the operation.
describeInsightRulesResponse_insightRules :: Lens.Lens' DescribeInsightRulesResponse (Prelude.Maybe [InsightRule])
describeInsightRulesResponse_insightRules :: Lens' DescribeInsightRulesResponse (Maybe [InsightRule])
describeInsightRulesResponse_insightRules = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeInsightRulesResponse' {Maybe [InsightRule]
insightRules :: Maybe [InsightRule]
$sel:insightRules:DescribeInsightRulesResponse' :: DescribeInsightRulesResponse -> Maybe [InsightRule]
insightRules} -> Maybe [InsightRule]
insightRules) (\s :: DescribeInsightRulesResponse
s@DescribeInsightRulesResponse' {} Maybe [InsightRule]
a -> DescribeInsightRulesResponse
s {$sel:insightRules:DescribeInsightRulesResponse' :: Maybe [InsightRule]
insightRules = Maybe [InsightRule]
a} :: DescribeInsightRulesResponse) forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall (f :: * -> *) (g :: * -> *) s t a b.
(Functor f, Functor g) =>
AnIso s t a b -> Iso (f s) (g t) (f a) (g b)
Lens.mapping forall s t a b. (Coercible s a, Coercible t b) => Iso s t a b
Lens.coerced

-- | If this parameter is present, it is a token that marks the start of the
-- next batch of returned results.
describeInsightRulesResponse_nextToken :: Lens.Lens' DescribeInsightRulesResponse (Prelude.Maybe Prelude.Text)
describeInsightRulesResponse_nextToken :: Lens' DescribeInsightRulesResponse (Maybe Text)
describeInsightRulesResponse_nextToken = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeInsightRulesResponse' {Maybe Text
nextToken :: Maybe Text
$sel:nextToken:DescribeInsightRulesResponse' :: DescribeInsightRulesResponse -> Maybe Text
nextToken} -> Maybe Text
nextToken) (\s :: DescribeInsightRulesResponse
s@DescribeInsightRulesResponse' {} Maybe Text
a -> DescribeInsightRulesResponse
s {$sel:nextToken:DescribeInsightRulesResponse' :: Maybe Text
nextToken = Maybe Text
a} :: DescribeInsightRulesResponse)

-- | The response's http status code.
describeInsightRulesResponse_httpStatus :: Lens.Lens' DescribeInsightRulesResponse Prelude.Int
describeInsightRulesResponse_httpStatus :: Lens' DescribeInsightRulesResponse Int
describeInsightRulesResponse_httpStatus = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeInsightRulesResponse' {Int
httpStatus :: Int
$sel:httpStatus:DescribeInsightRulesResponse' :: DescribeInsightRulesResponse -> Int
httpStatus} -> Int
httpStatus) (\s :: DescribeInsightRulesResponse
s@DescribeInsightRulesResponse' {} Int
a -> DescribeInsightRulesResponse
s {$sel:httpStatus:DescribeInsightRulesResponse' :: Int
httpStatus = Int
a} :: DescribeInsightRulesResponse)

instance Prelude.NFData DescribeInsightRulesResponse where
  rnf :: DescribeInsightRulesResponse -> ()
rnf DescribeInsightRulesResponse' {Int
Maybe [InsightRule]
Maybe Text
httpStatus :: Int
nextToken :: Maybe Text
insightRules :: Maybe [InsightRule]
$sel:httpStatus:DescribeInsightRulesResponse' :: DescribeInsightRulesResponse -> Int
$sel:nextToken:DescribeInsightRulesResponse' :: DescribeInsightRulesResponse -> Maybe Text
$sel:insightRules:DescribeInsightRulesResponse' :: DescribeInsightRulesResponse -> Maybe [InsightRule]
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe [InsightRule]
insightRules
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
nextToken
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Int
httpStatus