ListIPSets.hs

{-# LANGUAGE DeriveDataTypeable #-}
{-# LANGUAGE DeriveGeneric      #-}
{-# LANGUAGE OverloadedStrings  #-}
{-# LANGUAGE RecordWildCards    #-}
{-# LANGUAGE TypeFamilies       #-}

{-# OPTIONS_GHC -fno-warn-unused-imports #-}
{-# OPTIONS_GHC -fno-warn-unused-binds   #-}
{-# OPTIONS_GHC -fno-warn-unused-matches #-}

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

-- |
-- Module      : Network.AWS.WAF.ListIPSets
-- Copyright   : (c) 2013-2015 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay <brendan.g.hay@gmail.com>
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
--
-- Returns an array of IPSetSummary objects in the response.
--
-- /See:/ <http://docs.aws.amazon.com/waf/latest/APIReference/API_ListIPSets.html AWS API Reference> for ListIPSets.
module Network.AWS.WAF.ListIPSets
    (
    -- * Creating a Request
      listIPSets
    , ListIPSets
    -- * Request Lenses
    , lisNextMarker
    , lisLimit

    -- * Destructuring the Response
    , listIPSetsResponse
    , ListIPSetsResponse
    -- * Response Lenses
    , lisrsNextMarker
    , lisrsIPSets
    , lisrsResponseStatus
    ) where

import           Network.AWS.Prelude
import           Network.AWS.Request
import           Network.AWS.Response
import           Network.AWS.WAF.Types
import           Network.AWS.WAF.Types.Product

-- | /See:/ 'listIPSets' smart constructor.
data ListIPSets = ListIPSets'
    { _lisNextMarker :: !(Maybe Text)
    , _lisLimit      :: !Nat
    } deriving (Eq,Read,Show,Data,Typeable,Generic)

-- | Creates a value of 'ListIPSets' with the minimum fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
-- * 'lisNextMarker'
--
-- * 'lisLimit'
listIPSets
    :: Natural -- ^ 'lisLimit'
    -> ListIPSets
listIPSets pLimit_ =
    ListIPSets'
    { _lisNextMarker = Nothing
    , _lisLimit = _Nat # pLimit_
    }

-- | If you specify a value for 'Limit' and you have more 'IPSets' than the
-- value of 'Limit', AWS WAF returns a 'NextMarker' value in the response
-- that allows you to list another group of 'IPSets'. For the second and
-- subsequent 'ListIPSets' requests, specify the value of 'NextMarker' from
-- the previous response to get information about another batch of
-- 'ByteMatchSets'.
lisNextMarker :: Lens' ListIPSets (Maybe Text)
lisNextMarker = lens _lisNextMarker (\ s a -> s{_lisNextMarker = a});

-- | Specifies the number of 'IPSet' objects that you want AWS WAF to return
-- for this request. If you have more 'IPSet' objects than the number you
-- specify for 'Limit', the response includes a 'NextMarker' value that you
-- can use to get another batch of 'IPSet' objects.
lisLimit :: Lens' ListIPSets Natural
lisLimit = lens _lisLimit (\ s a -> s{_lisLimit = a}) . _Nat;

instance AWSRequest ListIPSets where
        type Rs ListIPSets = ListIPSetsResponse
        request = postJSON wAF
        response
          = receiveJSON
              (\ s h x ->
                 ListIPSetsResponse' <$>
                   (x .?> "NextMarker") <*> (x .?> "IPSets" .!@ mempty)
                     <*> (pure (fromEnum s)))

instance ToHeaders ListIPSets where
        toHeaders
          = const
              (mconcat
                 ["X-Amz-Target" =#
                    ("AWSWAF_20150824.ListIPSets" :: ByteString),
                  "Content-Type" =#
                    ("application/x-amz-json-1.1" :: ByteString)])

instance ToJSON ListIPSets where
        toJSON ListIPSets'{..}
          = object
              (catMaybes
                 [("NextMarker" .=) <$> _lisNextMarker,
                  Just ("Limit" .= _lisLimit)])

instance ToPath ListIPSets where
        toPath = const "/"

instance ToQuery ListIPSets where
        toQuery = const mempty

-- | /See:/ 'listIPSetsResponse' smart constructor.
data ListIPSetsResponse = ListIPSetsResponse'
    { _lisrsNextMarker     :: !(Maybe Text)
    , _lisrsIPSets         :: !(Maybe [IPSetSummary])
    , _lisrsResponseStatus :: !Int
    } deriving (Eq,Read,Show,Data,Typeable,Generic)

-- | Creates a value of 'ListIPSetsResponse' with the minimum fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
-- * 'lisrsNextMarker'
--
-- * 'lisrsIPSets'
--
-- * 'lisrsResponseStatus'
listIPSetsResponse
    :: Int -- ^ 'lisrsResponseStatus'
    -> ListIPSetsResponse
listIPSetsResponse pResponseStatus_ =
    ListIPSetsResponse'
    { _lisrsNextMarker = Nothing
    , _lisrsIPSets = Nothing
    , _lisrsResponseStatus = pResponseStatus_
    }

-- | If you have more 'IPSet' objects than the number that you specified for
-- 'Limit' in the request, the response includes a 'NextMarker' value. To
-- list more 'IPSet' objects, submit another 'ListIPSets' request, and
-- specify the 'NextMarker' value from the response in the 'NextMarker'
-- value in the next request.
lisrsNextMarker :: Lens' ListIPSetsResponse (Maybe Text)
lisrsNextMarker = lens _lisrsNextMarker (\ s a -> s{_lisrsNextMarker = a});

-- | An array of IPSetSummary objects.
lisrsIPSets :: Lens' ListIPSetsResponse [IPSetSummary]
lisrsIPSets = lens _lisrsIPSets (\ s a -> s{_lisrsIPSets = a}) . _Default . _Coerce;

-- | The response status code.
lisrsResponseStatus :: Lens' ListIPSetsResponse Int
lisrsResponseStatus = lens _lisrsResponseStatus (\ s a -> s{_lisrsResponseStatus = a});