{-# 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.WAFRegional.ListRules
-- Copyright   : (c) 2013-2021 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay <brendan.g.hay+amazonka@gmail.com>
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
--
-- This is __AWS WAF Classic__ documentation. For more information, see
-- <https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html AWS WAF Classic>
-- in the developer guide.
--
-- __For the latest version of AWS WAF__, use the AWS WAFV2 API and see the
-- <https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html AWS WAF Developer Guide>.
-- With the latest version, AWS WAF has a single set of endpoints for
-- regional and global use.
--
-- Returns an array of RuleSummary objects.
module Amazonka.WAFRegional.ListRules
  ( -- * Creating a Request
    ListRules (..),
    newListRules,

    -- * Request Lenses
    listRules_nextMarker,
    listRules_limit,

    -- * Destructuring the Response
    ListRulesResponse (..),
    newListRulesResponse,

    -- * Response Lenses
    listRulesResponse_rules,
    listRulesResponse_nextMarker,
    listRulesResponse_httpStatus,
  )
where

import qualified Amazonka.Core as Core
import qualified Amazonka.Lens as Lens
import qualified Amazonka.Prelude as Prelude
import qualified Amazonka.Request as Request
import qualified Amazonka.Response as Response
import Amazonka.WAFRegional.Types

-- | /See:/ 'newListRules' smart constructor.
data ListRules = ListRules'
  { -- | If you specify a value for @Limit@ and you have more @Rules@ than the
    -- value of @Limit@, AWS WAF returns a @NextMarker@ value in the response
    -- that allows you to list another group of @Rules@. For the second and
    -- subsequent @ListRules@ requests, specify the value of @NextMarker@ from
    -- the previous response to get information about another batch of @Rules@.
    ListRules -> Maybe Text
nextMarker :: Prelude.Maybe Prelude.Text,
    -- | Specifies the number of @Rules@ that you want AWS WAF to return for this
    -- request. If you have more @Rules@ than the number that you specify for
    -- @Limit@, the response includes a @NextMarker@ value that you can use to
    -- get another batch of @Rules@.
    ListRules -> Maybe Natural
limit :: Prelude.Maybe Prelude.Natural
  }
  deriving (ListRules -> ListRules -> Bool
(ListRules -> ListRules -> Bool)
-> (ListRules -> ListRules -> Bool) -> Eq ListRules
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: ListRules -> ListRules -> Bool
$c/= :: ListRules -> ListRules -> Bool
== :: ListRules -> ListRules -> Bool
$c== :: ListRules -> ListRules -> Bool
Prelude.Eq, ReadPrec [ListRules]
ReadPrec ListRules
Int -> ReadS ListRules
ReadS [ListRules]
(Int -> ReadS ListRules)
-> ReadS [ListRules]
-> ReadPrec ListRules
-> ReadPrec [ListRules]
-> Read ListRules
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [ListRules]
$creadListPrec :: ReadPrec [ListRules]
readPrec :: ReadPrec ListRules
$creadPrec :: ReadPrec ListRules
readList :: ReadS [ListRules]
$creadList :: ReadS [ListRules]
readsPrec :: Int -> ReadS ListRules
$creadsPrec :: Int -> ReadS ListRules
Prelude.Read, Int -> ListRules -> ShowS
[ListRules] -> ShowS
ListRules -> String
(Int -> ListRules -> ShowS)
-> (ListRules -> String)
-> ([ListRules] -> ShowS)
-> Show ListRules
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [ListRules] -> ShowS
$cshowList :: [ListRules] -> ShowS
show :: ListRules -> String
$cshow :: ListRules -> String
showsPrec :: Int -> ListRules -> ShowS
$cshowsPrec :: Int -> ListRules -> ShowS
Prelude.Show, (forall x. ListRules -> Rep ListRules x)
-> (forall x. Rep ListRules x -> ListRules) -> Generic ListRules
forall x. Rep ListRules x -> ListRules
forall x. ListRules -> Rep ListRules x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep ListRules x -> ListRules
$cfrom :: forall x. ListRules -> Rep ListRules x
Prelude.Generic)

-- |
-- Create a value of 'ListRules' 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:
--
-- 'nextMarker', 'listRules_nextMarker' - If you specify a value for @Limit@ and you have more @Rules@ than the
-- value of @Limit@, AWS WAF returns a @NextMarker@ value in the response
-- that allows you to list another group of @Rules@. For the second and
-- subsequent @ListRules@ requests, specify the value of @NextMarker@ from
-- the previous response to get information about another batch of @Rules@.
--
-- 'limit', 'listRules_limit' - Specifies the number of @Rules@ that you want AWS WAF to return for this
-- request. If you have more @Rules@ than the number that you specify for
-- @Limit@, the response includes a @NextMarker@ value that you can use to
-- get another batch of @Rules@.
newListRules ::
  ListRules
newListRules :: ListRules
newListRules =
  ListRules' :: Maybe Text -> Maybe Natural -> ListRules
ListRules'
    { $sel:nextMarker:ListRules' :: Maybe Text
nextMarker = Maybe Text
forall a. Maybe a
Prelude.Nothing,
      $sel:limit:ListRules' :: Maybe Natural
limit = Maybe Natural
forall a. Maybe a
Prelude.Nothing
    }

-- | If you specify a value for @Limit@ and you have more @Rules@ than the
-- value of @Limit@, AWS WAF returns a @NextMarker@ value in the response
-- that allows you to list another group of @Rules@. For the second and
-- subsequent @ListRules@ requests, specify the value of @NextMarker@ from
-- the previous response to get information about another batch of @Rules@.
listRules_nextMarker :: Lens.Lens' ListRules (Prelude.Maybe Prelude.Text)
listRules_nextMarker :: (Maybe Text -> f (Maybe Text)) -> ListRules -> f ListRules
listRules_nextMarker = (ListRules -> Maybe Text)
-> (ListRules -> Maybe Text -> ListRules)
-> Lens ListRules ListRules (Maybe Text) (Maybe Text)
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListRules' {Maybe Text
nextMarker :: Maybe Text
$sel:nextMarker:ListRules' :: ListRules -> Maybe Text
nextMarker} -> Maybe Text
nextMarker) (\s :: ListRules
s@ListRules' {} Maybe Text
a -> ListRules
s {$sel:nextMarker:ListRules' :: Maybe Text
nextMarker = Maybe Text
a} :: ListRules)

-- | Specifies the number of @Rules@ that you want AWS WAF to return for this
-- request. If you have more @Rules@ than the number that you specify for
-- @Limit@, the response includes a @NextMarker@ value that you can use to
-- get another batch of @Rules@.
listRules_limit :: Lens.Lens' ListRules (Prelude.Maybe Prelude.Natural)
listRules_limit :: (Maybe Natural -> f (Maybe Natural)) -> ListRules -> f ListRules
listRules_limit = (ListRules -> Maybe Natural)
-> (ListRules -> Maybe Natural -> ListRules)
-> Lens ListRules ListRules (Maybe Natural) (Maybe Natural)
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListRules' {Maybe Natural
limit :: Maybe Natural
$sel:limit:ListRules' :: ListRules -> Maybe Natural
limit} -> Maybe Natural
limit) (\s :: ListRules
s@ListRules' {} Maybe Natural
a -> ListRules
s {$sel:limit:ListRules' :: Maybe Natural
limit = Maybe Natural
a} :: ListRules)

instance Core.AWSRequest ListRules where
  type AWSResponse ListRules = ListRulesResponse
  request :: ListRules -> Request ListRules
request = Service -> ListRules -> Request ListRules
forall a. (ToRequest a, ToJSON a) => Service -> a -> Request a
Request.postJSON Service
defaultService
  response :: Logger
-> Service
-> Proxy ListRules
-> ClientResponse ClientBody
-> m (Either Error (ClientResponse (AWSResponse ListRules)))
response =
    (Int
 -> ResponseHeaders
 -> Object
 -> Either String (AWSResponse ListRules))
-> Logger
-> Service
-> Proxy ListRules
-> ClientResponse ClientBody
-> m (Either Error (ClientResponse (AWSResponse ListRules)))
forall (m :: * -> *) a.
MonadResource m =>
(Int -> ResponseHeaders -> Object -> Either String (AWSResponse a))
-> Logger
-> Service
-> Proxy a
-> ClientResponse ClientBody
-> m (Either Error (ClientResponse (AWSResponse a)))
Response.receiveJSON
      ( \Int
s ResponseHeaders
h Object
x ->
          Maybe [RuleSummary] -> Maybe Text -> Int -> ListRulesResponse
ListRulesResponse'
            (Maybe [RuleSummary] -> Maybe Text -> Int -> ListRulesResponse)
-> Either String (Maybe [RuleSummary])
-> Either String (Maybe Text -> Int -> ListRulesResponse)
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> (Object
x Object -> Text -> Either String (Maybe (Maybe [RuleSummary]))
forall a. FromJSON a => Object -> Text -> Either String (Maybe a)
Core..?> Text
"Rules" Either String (Maybe (Maybe [RuleSummary]))
-> Maybe [RuleSummary] -> Either String (Maybe [RuleSummary])
forall (f :: * -> *) a. Functor f => f (Maybe a) -> a -> f a
Core..!@ Maybe [RuleSummary]
forall a. Monoid a => a
Prelude.mempty)
            Either String (Maybe Text -> Int -> ListRulesResponse)
-> Either String (Maybe Text)
-> Either String (Int -> ListRulesResponse)
forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x Object -> Text -> Either String (Maybe Text)
forall a. FromJSON a => Object -> Text -> Either String (Maybe a)
Core..?> Text
"NextMarker")
            Either String (Int -> ListRulesResponse)
-> Either String Int -> Either String ListRulesResponse
forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Int -> Either String Int
forall (f :: * -> *) a. Applicative f => a -> f a
Prelude.pure (Int -> Int
forall a. Enum a => a -> Int
Prelude.fromEnum Int
s))
      )

instance Prelude.Hashable ListRules

instance Prelude.NFData ListRules

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

instance Core.ToJSON ListRules where
  toJSON :: ListRules -> Value
toJSON ListRules' {Maybe Natural
Maybe Text
limit :: Maybe Natural
nextMarker :: Maybe Text
$sel:limit:ListRules' :: ListRules -> Maybe Natural
$sel:nextMarker:ListRules' :: ListRules -> Maybe Text
..} =
    [Pair] -> Value
Core.object
      ( [Maybe Pair] -> [Pair]
forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ (Text
"NextMarker" Text -> Text -> Pair
forall kv v. (KeyValue kv, ToJSON v) => Text -> v -> kv
Core..=) (Text -> Pair) -> Maybe Text -> Maybe Pair
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe Text
nextMarker,
            (Text
"Limit" Text -> Natural -> Pair
forall kv v. (KeyValue kv, ToJSON v) => Text -> v -> kv
Core..=) (Natural -> Pair) -> Maybe Natural -> Maybe Pair
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe Natural
limit
          ]
      )

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

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

-- | /See:/ 'newListRulesResponse' smart constructor.
data ListRulesResponse = ListRulesResponse'
  { -- | An array of RuleSummary objects.
    ListRulesResponse -> Maybe [RuleSummary]
rules :: Prelude.Maybe [RuleSummary],
    -- | If you have more @Rules@ than the number that you specified for @Limit@
    -- in the request, the response includes a @NextMarker@ value. To list more
    -- @Rules@, submit another @ListRules@ request, and specify the
    -- @NextMarker@ value from the response in the @NextMarker@ value in the
    -- next request.
    ListRulesResponse -> Maybe Text
nextMarker :: Prelude.Maybe Prelude.Text,
    -- | The response's http status code.
    ListRulesResponse -> Int
httpStatus :: Prelude.Int
  }
  deriving (ListRulesResponse -> ListRulesResponse -> Bool
(ListRulesResponse -> ListRulesResponse -> Bool)
-> (ListRulesResponse -> ListRulesResponse -> Bool)
-> Eq ListRulesResponse
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: ListRulesResponse -> ListRulesResponse -> Bool
$c/= :: ListRulesResponse -> ListRulesResponse -> Bool
== :: ListRulesResponse -> ListRulesResponse -> Bool
$c== :: ListRulesResponse -> ListRulesResponse -> Bool
Prelude.Eq, ReadPrec [ListRulesResponse]
ReadPrec ListRulesResponse
Int -> ReadS ListRulesResponse
ReadS [ListRulesResponse]
(Int -> ReadS ListRulesResponse)
-> ReadS [ListRulesResponse]
-> ReadPrec ListRulesResponse
-> ReadPrec [ListRulesResponse]
-> Read ListRulesResponse
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [ListRulesResponse]
$creadListPrec :: ReadPrec [ListRulesResponse]
readPrec :: ReadPrec ListRulesResponse
$creadPrec :: ReadPrec ListRulesResponse
readList :: ReadS [ListRulesResponse]
$creadList :: ReadS [ListRulesResponse]
readsPrec :: Int -> ReadS ListRulesResponse
$creadsPrec :: Int -> ReadS ListRulesResponse
Prelude.Read, Int -> ListRulesResponse -> ShowS
[ListRulesResponse] -> ShowS
ListRulesResponse -> String
(Int -> ListRulesResponse -> ShowS)
-> (ListRulesResponse -> String)
-> ([ListRulesResponse] -> ShowS)
-> Show ListRulesResponse
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [ListRulesResponse] -> ShowS
$cshowList :: [ListRulesResponse] -> ShowS
show :: ListRulesResponse -> String
$cshow :: ListRulesResponse -> String
showsPrec :: Int -> ListRulesResponse -> ShowS
$cshowsPrec :: Int -> ListRulesResponse -> ShowS
Prelude.Show, (forall x. ListRulesResponse -> Rep ListRulesResponse x)
-> (forall x. Rep ListRulesResponse x -> ListRulesResponse)
-> Generic ListRulesResponse
forall x. Rep ListRulesResponse x -> ListRulesResponse
forall x. ListRulesResponse -> Rep ListRulesResponse x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep ListRulesResponse x -> ListRulesResponse
$cfrom :: forall x. ListRulesResponse -> Rep ListRulesResponse x
Prelude.Generic)

-- |
-- Create a value of 'ListRulesResponse' 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:
--
-- 'rules', 'listRulesResponse_rules' - An array of RuleSummary objects.
--
-- 'nextMarker', 'listRulesResponse_nextMarker' - If you have more @Rules@ than the number that you specified for @Limit@
-- in the request, the response includes a @NextMarker@ value. To list more
-- @Rules@, submit another @ListRules@ request, and specify the
-- @NextMarker@ value from the response in the @NextMarker@ value in the
-- next request.
--
-- 'httpStatus', 'listRulesResponse_httpStatus' - The response's http status code.
newListRulesResponse ::
  -- | 'httpStatus'
  Prelude.Int ->
  ListRulesResponse
newListRulesResponse :: Int -> ListRulesResponse
newListRulesResponse Int
pHttpStatus_ =
  ListRulesResponse' :: Maybe [RuleSummary] -> Maybe Text -> Int -> ListRulesResponse
ListRulesResponse'
    { $sel:rules:ListRulesResponse' :: Maybe [RuleSummary]
rules = Maybe [RuleSummary]
forall a. Maybe a
Prelude.Nothing,
      $sel:nextMarker:ListRulesResponse' :: Maybe Text
nextMarker = Maybe Text
forall a. Maybe a
Prelude.Nothing,
      $sel:httpStatus:ListRulesResponse' :: Int
httpStatus = Int
pHttpStatus_
    }

-- | An array of RuleSummary objects.
listRulesResponse_rules :: Lens.Lens' ListRulesResponse (Prelude.Maybe [RuleSummary])
listRulesResponse_rules :: (Maybe [RuleSummary] -> f (Maybe [RuleSummary]))
-> ListRulesResponse -> f ListRulesResponse
listRulesResponse_rules = (ListRulesResponse -> Maybe [RuleSummary])
-> (ListRulesResponse -> Maybe [RuleSummary] -> ListRulesResponse)
-> Lens
     ListRulesResponse
     ListRulesResponse
     (Maybe [RuleSummary])
     (Maybe [RuleSummary])
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListRulesResponse' {Maybe [RuleSummary]
rules :: Maybe [RuleSummary]
$sel:rules:ListRulesResponse' :: ListRulesResponse -> Maybe [RuleSummary]
rules} -> Maybe [RuleSummary]
rules) (\s :: ListRulesResponse
s@ListRulesResponse' {} Maybe [RuleSummary]
a -> ListRulesResponse
s {$sel:rules:ListRulesResponse' :: Maybe [RuleSummary]
rules = Maybe [RuleSummary]
a} :: ListRulesResponse) ((Maybe [RuleSummary] -> f (Maybe [RuleSummary]))
 -> ListRulesResponse -> f ListRulesResponse)
-> ((Maybe [RuleSummary] -> f (Maybe [RuleSummary]))
    -> Maybe [RuleSummary] -> f (Maybe [RuleSummary]))
-> (Maybe [RuleSummary] -> f (Maybe [RuleSummary]))
-> ListRulesResponse
-> f ListRulesResponse
forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. AnIso [RuleSummary] [RuleSummary] [RuleSummary] [RuleSummary]
-> Iso
     (Maybe [RuleSummary])
     (Maybe [RuleSummary])
     (Maybe [RuleSummary])
     (Maybe [RuleSummary])
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 AnIso [RuleSummary] [RuleSummary] [RuleSummary] [RuleSummary]
forall s t a b. (Coercible s a, Coercible t b) => Iso s t a b
Lens.coerced

-- | If you have more @Rules@ than the number that you specified for @Limit@
-- in the request, the response includes a @NextMarker@ value. To list more
-- @Rules@, submit another @ListRules@ request, and specify the
-- @NextMarker@ value from the response in the @NextMarker@ value in the
-- next request.
listRulesResponse_nextMarker :: Lens.Lens' ListRulesResponse (Prelude.Maybe Prelude.Text)
listRulesResponse_nextMarker :: (Maybe Text -> f (Maybe Text))
-> ListRulesResponse -> f ListRulesResponse
listRulesResponse_nextMarker = (ListRulesResponse -> Maybe Text)
-> (ListRulesResponse -> Maybe Text -> ListRulesResponse)
-> Lens
     ListRulesResponse ListRulesResponse (Maybe Text) (Maybe Text)
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListRulesResponse' {Maybe Text
nextMarker :: Maybe Text
$sel:nextMarker:ListRulesResponse' :: ListRulesResponse -> Maybe Text
nextMarker} -> Maybe Text
nextMarker) (\s :: ListRulesResponse
s@ListRulesResponse' {} Maybe Text
a -> ListRulesResponse
s {$sel:nextMarker:ListRulesResponse' :: Maybe Text
nextMarker = Maybe Text
a} :: ListRulesResponse)

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

instance Prelude.NFData ListRulesResponse