{-# 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.Redshift.DescribeClusterSubnetGroups
-- Copyright   : (c) 2013-2016 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 one or more cluster subnet group objects, which contain metadata about your cluster subnet groups. By default, this operation returns information about all cluster subnet groups that are defined in you AWS account.
--
-- If you specify both tag keys and tag values in the same request, Amazon Redshift returns all subnet groups that match any combination of the specified keys and values. For example, if you have 'owner' and 'environment' for tag keys, and 'admin' and 'test' for tag values, all subnet groups that have any combination of those values are returned.
--
-- If both tag keys and values are omitted from the request, subnet groups are returned regardless of whether they have tag keys or values associated with them.
--
-- This operation returns paginated results.
module Network.AWS.Redshift.DescribeClusterSubnetGroups
    (
    -- * Creating a Request
      describeClusterSubnetGroups
    , DescribeClusterSubnetGroups
    -- * Request Lenses
    , dcsgsTagValues
    , dcsgsTagKeys
    , dcsgsClusterSubnetGroupName
    , dcsgsMarker
    , dcsgsMaxRecords

    -- * Destructuring the Response
    , describeClusterSubnetGroupsResponse
    , DescribeClusterSubnetGroupsResponse
    -- * Response Lenses
    , dcsgrsClusterSubnetGroups
    , dcsgrsMarker
    , dcsgrsResponseStatus
    ) where

import           Network.AWS.Lens
import           Network.AWS.Pager
import           Network.AWS.Prelude
import           Network.AWS.Redshift.Types
import           Network.AWS.Redshift.Types.Product
import           Network.AWS.Request
import           Network.AWS.Response

-- |
--
-- /See:/ 'describeClusterSubnetGroups' smart constructor.
data DescribeClusterSubnetGroups = DescribeClusterSubnetGroups'
    { _dcsgsTagValues              :: !(Maybe [Text])
    , _dcsgsTagKeys                :: !(Maybe [Text])
    , _dcsgsClusterSubnetGroupName :: !(Maybe Text)
    , _dcsgsMarker                 :: !(Maybe Text)
    , _dcsgsMaxRecords             :: !(Maybe Int)
    } deriving (Eq,Read,Show,Data,Typeable,Generic)

-- | Creates a value of 'DescribeClusterSubnetGroups' with the minimum fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
-- * 'dcsgsTagValues'
--
-- * 'dcsgsTagKeys'
--
-- * 'dcsgsClusterSubnetGroupName'
--
-- * 'dcsgsMarker'
--
-- * 'dcsgsMaxRecords'
describeClusterSubnetGroups
    :: DescribeClusterSubnetGroups
describeClusterSubnetGroups =
    DescribeClusterSubnetGroups'
    { _dcsgsTagValues = Nothing
    , _dcsgsTagKeys = Nothing
    , _dcsgsClusterSubnetGroupName = Nothing
    , _dcsgsMarker = Nothing
    , _dcsgsMaxRecords = Nothing
    }

-- | A tag value or values for which you want to return all matching cluster subnet groups that are associated with the specified tag value or values. For example, suppose that you have subnet groups that are tagged with values called 'admin' and 'test'. If you specify both of these tag values in the request, Amazon Redshift returns a response with the subnet groups that have either or both of these tag values associated with them.
dcsgsTagValues :: Lens' DescribeClusterSubnetGroups [Text]
dcsgsTagValues = lens _dcsgsTagValues (\ s a -> s{_dcsgsTagValues = a}) . _Default . _Coerce;

-- | A tag key or keys for which you want to return all matching cluster subnet groups that are associated with the specified key or keys. For example, suppose that you have subnet groups that are tagged with keys called 'owner' and 'environment'. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the subnet groups that have either or both of these tag keys associated with them.
dcsgsTagKeys :: Lens' DescribeClusterSubnetGroups [Text]
dcsgsTagKeys = lens _dcsgsTagKeys (\ s a -> s{_dcsgsTagKeys = a}) . _Default . _Coerce;

-- | The name of the cluster subnet group for which information is requested.
dcsgsClusterSubnetGroupName :: Lens' DescribeClusterSubnetGroups (Maybe Text)
dcsgsClusterSubnetGroupName = lens _dcsgsClusterSubnetGroupName (\ s a -> s{_dcsgsClusterSubnetGroupName = a});

-- | An optional parameter that specifies the starting point to return a set of response records. When the results of a < DescribeClusterSubnetGroups> request exceed the value specified in 'MaxRecords', AWS returns a value in the 'Marker' field of the response. You can retrieve the next set of response records by providing the returned marker value in the 'Marker' parameter and retrying the request.
dcsgsMarker :: Lens' DescribeClusterSubnetGroups (Maybe Text)
dcsgsMarker = lens _dcsgsMarker (\ s a -> s{_dcsgsMarker = a});

-- | The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified 'MaxRecords' value, a value is returned in a 'marker' field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.
--
-- Default: '100'
--
-- Constraints: minimum 20, maximum 100.
dcsgsMaxRecords :: Lens' DescribeClusterSubnetGroups (Maybe Int)
dcsgsMaxRecords = lens _dcsgsMaxRecords (\ s a -> s{_dcsgsMaxRecords = a});

instance AWSPager DescribeClusterSubnetGroups where
        page rq rs
          | stop (rs ^. dcsgrsMarker) = Nothing
          | stop (rs ^. dcsgrsClusterSubnetGroups) = Nothing
          | otherwise =
            Just $ rq & dcsgsMarker .~ rs ^. dcsgrsMarker

instance AWSRequest DescribeClusterSubnetGroups where
        type Rs DescribeClusterSubnetGroups =
             DescribeClusterSubnetGroupsResponse
        request = postQuery redshift
        response
          = receiveXMLWrapper
              "DescribeClusterSubnetGroupsResult"
              (\ s h x ->
                 DescribeClusterSubnetGroupsResponse' <$>
                   (x .@? "ClusterSubnetGroups" .!@ mempty >>=
                      may (parseXMLList "ClusterSubnetGroup"))
                     <*> (x .@? "Marker")
                     <*> (pure (fromEnum s)))

instance Hashable DescribeClusterSubnetGroups

instance NFData DescribeClusterSubnetGroups

instance ToHeaders DescribeClusterSubnetGroups where
        toHeaders = const mempty

instance ToPath DescribeClusterSubnetGroups where
        toPath = const "/"

instance ToQuery DescribeClusterSubnetGroups where
        toQuery DescribeClusterSubnetGroups'{..}
          = mconcat
              ["Action" =:
                 ("DescribeClusterSubnetGroups" :: ByteString),
               "Version" =: ("2012-12-01" :: ByteString),
               "TagValues" =:
                 toQuery (toQueryList "TagValue" <$> _dcsgsTagValues),
               "TagKeys" =:
                 toQuery (toQueryList "TagKey" <$> _dcsgsTagKeys),
               "ClusterSubnetGroupName" =:
                 _dcsgsClusterSubnetGroupName,
               "Marker" =: _dcsgsMarker,
               "MaxRecords" =: _dcsgsMaxRecords]

-- | Contains the output from the < DescribeClusterSubnetGroups> action.
--
-- /See:/ 'describeClusterSubnetGroupsResponse' smart constructor.
data DescribeClusterSubnetGroupsResponse = DescribeClusterSubnetGroupsResponse'
    { _dcsgrsClusterSubnetGroups :: !(Maybe [ClusterSubnetGroup])
    , _dcsgrsMarker              :: !(Maybe Text)
    , _dcsgrsResponseStatus      :: !Int
    } deriving (Eq,Read,Show,Data,Typeable,Generic)

-- | Creates a value of 'DescribeClusterSubnetGroupsResponse' with the minimum fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
-- * 'dcsgrsClusterSubnetGroups'
--
-- * 'dcsgrsMarker'
--
-- * 'dcsgrsResponseStatus'
describeClusterSubnetGroupsResponse
    :: Int -- ^ 'dcsgrsResponseStatus'
    -> DescribeClusterSubnetGroupsResponse
describeClusterSubnetGroupsResponse pResponseStatus_ =
    DescribeClusterSubnetGroupsResponse'
    { _dcsgrsClusterSubnetGroups = Nothing
    , _dcsgrsMarker = Nothing
    , _dcsgrsResponseStatus = pResponseStatus_
    }

-- | A list of < ClusterSubnetGroup> instances.
dcsgrsClusterSubnetGroups :: Lens' DescribeClusterSubnetGroupsResponse [ClusterSubnetGroup]
dcsgrsClusterSubnetGroups = lens _dcsgrsClusterSubnetGroups (\ s a -> s{_dcsgrsClusterSubnetGroups = a}) . _Default . _Coerce;

-- | A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the 'Marker' parameter and retrying the command. If the 'Marker' field is empty, all response records have been retrieved for the request.
dcsgrsMarker :: Lens' DescribeClusterSubnetGroupsResponse (Maybe Text)
dcsgrsMarker = lens _dcsgrsMarker (\ s a -> s{_dcsgrsMarker = a});

-- | The response status code.
dcsgrsResponseStatus :: Lens' DescribeClusterSubnetGroupsResponse Int
dcsgrsResponseStatus = lens _dcsgrsResponseStatus (\ s a -> s{_dcsgrsResponseStatus = a});

instance NFData DescribeClusterSubnetGroupsResponse