DescribeClusterSubnetGroups.hs

{-# LANGUAGE DataKinds                   #-}
{-# LANGUAGE DeriveGeneric               #-}
{-# LANGUAGE FlexibleInstances           #-}
{-# LANGUAGE GeneralizedNewtypeDeriving  #-}
{-# LANGUAGE LambdaCase                  #-}
{-# LANGUAGE NoImplicitPrelude           #-}
{-# LANGUAGE OverloadedStrings           #-}
{-# LANGUAGE RecordWildCards             #-}
{-# LANGUAGE TypeFamilies                #-}

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

-- Module      : Network.AWS.Redshift.DescribeClusterSubnetGroups
-- Copyright   : (c) 2013-2014 Brendan Hay <brendan.g.hay@gmail.com>
-- License     : This Source Code Form is subject to the terms of
--               the Mozilla Public License, v. 2.0.
--               A copy of the MPL can be found in the LICENSE file or
--               you can obtain it at http://mozilla.org/MPL/2.0/.
-- Maintainer  : Brendan Hay <brendan.g.hay@gmail.com>
-- Stability   : experimental
-- Portability : non-portable (GHC extensions)
--
-- Derived from AWS service descriptions, licensed under Apache 2.0.

-- | 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.
--
-- <http://docs.aws.amazon.com/redshift/latest/APIReference/API_DescribeClusterSubnetGroups.html>
module Network.AWS.Redshift.DescribeClusterSubnetGroups
    (
    -- * Request
      DescribeClusterSubnetGroups
    -- ** Request constructor
    , describeClusterSubnetGroups
    -- ** Request lenses
    , dcsg1ClusterSubnetGroupName
    , dcsg1Marker
    , dcsg1MaxRecords
    , dcsg1TagKeys
    , dcsg1TagValues

    -- * Response
    , DescribeClusterSubnetGroupsResponse
    -- ** Response constructor
    , describeClusterSubnetGroupsResponse
    -- ** Response lenses
    , dcsgrClusterSubnetGroups
    , dcsgrMarker
    ) where

import Network.AWS.Prelude
import Network.AWS.Request.Query
import Network.AWS.Redshift.Types
import qualified GHC.Exts

data DescribeClusterSubnetGroups = DescribeClusterSubnetGroups
    { _dcsg1ClusterSubnetGroupName :: Maybe Text
    , _dcsg1Marker                 :: Maybe Text
    , _dcsg1MaxRecords             :: Maybe Int
    , _dcsg1TagKeys                :: List "member" Text
    , _dcsg1TagValues              :: List "member" Text
    } deriving (Eq, Ord, Read, Show)

-- | 'DescribeClusterSubnetGroups' constructor.
--
-- The fields accessible through corresponding lenses are:
--
-- * 'dcsg1ClusterSubnetGroupName' @::@ 'Maybe' 'Text'
--
-- * 'dcsg1Marker' @::@ 'Maybe' 'Text'
--
-- * 'dcsg1MaxRecords' @::@ 'Maybe' 'Int'
--
-- * 'dcsg1TagKeys' @::@ ['Text']
--
-- * 'dcsg1TagValues' @::@ ['Text']
--
describeClusterSubnetGroups :: DescribeClusterSubnetGroups
describeClusterSubnetGroups = DescribeClusterSubnetGroups
    { _dcsg1ClusterSubnetGroupName = Nothing
    , _dcsg1MaxRecords             = Nothing
    , _dcsg1Marker                 = Nothing
    , _dcsg1TagKeys                = mempty
    , _dcsg1TagValues              = mempty
    }

-- | The name of the cluster subnet group for which information is requested.
dcsg1ClusterSubnetGroupName :: Lens' DescribeClusterSubnetGroups (Maybe Text)
dcsg1ClusterSubnetGroupName =
    lens _dcsg1ClusterSubnetGroupName
        (\s a -> s { _dcsg1ClusterSubnetGroupName = 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.
dcsg1Marker :: Lens' DescribeClusterSubnetGroups (Maybe Text)
dcsg1Marker = lens _dcsg1Marker (\s a -> s { _dcsg1Marker = 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.
dcsg1MaxRecords :: Lens' DescribeClusterSubnetGroups (Maybe Int)
dcsg1MaxRecords = lens _dcsg1MaxRecords (\s a -> s { _dcsg1MaxRecords = a })

-- | 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.
dcsg1TagKeys :: Lens' DescribeClusterSubnetGroups [Text]
dcsg1TagKeys = lens _dcsg1TagKeys (\s a -> s { _dcsg1TagKeys = a }) . _List

-- | 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.
dcsg1TagValues :: Lens' DescribeClusterSubnetGroups [Text]
dcsg1TagValues = lens _dcsg1TagValues (\s a -> s { _dcsg1TagValues = a }) . _List

data DescribeClusterSubnetGroupsResponse = DescribeClusterSubnetGroupsResponse
    { _dcsgrClusterSubnetGroups :: List "member" ClusterSubnetGroup
    , _dcsgrMarker              :: Maybe Text
    } deriving (Eq, Read, Show)

-- | 'DescribeClusterSubnetGroupsResponse' constructor.
--
-- The fields accessible through corresponding lenses are:
--
-- * 'dcsgrClusterSubnetGroups' @::@ ['ClusterSubnetGroup']
--
-- * 'dcsgrMarker' @::@ 'Maybe' 'Text'
--
describeClusterSubnetGroupsResponse :: DescribeClusterSubnetGroupsResponse
describeClusterSubnetGroupsResponse = DescribeClusterSubnetGroupsResponse
    { _dcsgrMarker              = Nothing
    , _dcsgrClusterSubnetGroups = mempty
    }

-- | A list of 'ClusterSubnetGroup' instances.
dcsgrClusterSubnetGroups :: Lens' DescribeClusterSubnetGroupsResponse [ClusterSubnetGroup]
dcsgrClusterSubnetGroups =
    lens _dcsgrClusterSubnetGroups
        (\s a -> s { _dcsgrClusterSubnetGroups = a })
            . _List

-- | 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.
dcsgrMarker :: Lens' DescribeClusterSubnetGroupsResponse (Maybe Text)
dcsgrMarker = lens _dcsgrMarker (\s a -> s { _dcsgrMarker = a })

instance ToPath DescribeClusterSubnetGroups where
    toPath = const "/"

instance ToQuery DescribeClusterSubnetGroups where
    toQuery DescribeClusterSubnetGroups{..} = mconcat
        [ "ClusterSubnetGroupName" =? _dcsg1ClusterSubnetGroupName
        , "Marker"                 =? _dcsg1Marker
        , "MaxRecords"             =? _dcsg1MaxRecords
        , "TagKeys"                =? _dcsg1TagKeys
        , "TagValues"              =? _dcsg1TagValues
        ]

instance ToHeaders DescribeClusterSubnetGroups

instance AWSRequest DescribeClusterSubnetGroups where
    type Sv DescribeClusterSubnetGroups = Redshift
    type Rs DescribeClusterSubnetGroups = DescribeClusterSubnetGroupsResponse

    request  = post "DescribeClusterSubnetGroups"
    response = xmlResponse

instance FromXML DescribeClusterSubnetGroupsResponse where
    parseXML = withElement "DescribeClusterSubnetGroupsResult" $ \x -> DescribeClusterSubnetGroupsResponse
        <$> x .@? "ClusterSubnetGroups" .!@ mempty
        <*> x .@? "Marker"

instance AWSPager DescribeClusterSubnetGroups where
    page rq rs
        | stop (rq ^. dcsg1Marker) = Nothing
        | otherwise = (\x -> rq & dcsg1Marker ?~ x)
            <$> (rs ^. dcsgrMarker)