DescribeClusterParameterGroups.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.DescribeClusterParameterGroups
-- 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 a list of Amazon Redshift parameter groups, including parameter
-- groups you created and the default parameter group. For each parameter group,
-- the response includes the parameter group name, description, and parameter
-- group family name. You can optionally specify a name to retrieve the
-- description of a specific parameter group.
--
-- For more information about managing parameter groups, go to <http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-parameter-groups.html Amazon RedshiftParameter Groups> in the /Amazon Redshift Cluster Management Guide/.
--
-- If you specify both tag keys and tag values in the same request, Amazon
-- Redshift returns all parameter 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 parameter groups that have
-- any combination of those values are returned.
--
-- If both tag keys and values are omitted from the request, parameter groups
-- are returned regardless of whether they have tag keys or values associated
-- with them.
--
-- <http://docs.aws.amazon.com/redshift/latest/APIReference/API_DescribeClusterParameterGroups.html>
module Network.AWS.Redshift.DescribeClusterParameterGroups
    (
    -- * Request
      DescribeClusterParameterGroups
    -- ** Request constructor
    , describeClusterParameterGroups
    -- ** Request lenses
    , dcpgMarker
    , dcpgMaxRecords
    , dcpgParameterGroupName
    , dcpgTagKeys
    , dcpgTagValues

    -- * Response
    , DescribeClusterParameterGroupsResponse
    -- ** Response constructor
    , describeClusterParameterGroupsResponse
    -- ** Response lenses
    , dcpgrMarker
    , dcpgrParameterGroups
    ) where

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

data DescribeClusterParameterGroups = DescribeClusterParameterGroups
    { _dcpgMarker             :: Maybe Text
    , _dcpgMaxRecords         :: Maybe Int
    , _dcpgParameterGroupName :: Maybe Text
    , _dcpgTagKeys            :: List "member" Text
    , _dcpgTagValues          :: List "member" Text
    } deriving (Eq, Ord, Read, Show)

-- | 'DescribeClusterParameterGroups' constructor.
--
-- The fields accessible through corresponding lenses are:
--
-- * 'dcpgMarker' @::@ 'Maybe' 'Text'
--
-- * 'dcpgMaxRecords' @::@ 'Maybe' 'Int'
--
-- * 'dcpgParameterGroupName' @::@ 'Maybe' 'Text'
--
-- * 'dcpgTagKeys' @::@ ['Text']
--
-- * 'dcpgTagValues' @::@ ['Text']
--
describeClusterParameterGroups :: DescribeClusterParameterGroups
describeClusterParameterGroups = DescribeClusterParameterGroups
    { _dcpgParameterGroupName = Nothing
    , _dcpgMaxRecords         = Nothing
    , _dcpgMarker             = Nothing
    , _dcpgTagKeys            = mempty
    , _dcpgTagValues          = mempty
    }

-- | An optional parameter that specifies the starting point to return a set of
-- response records. When the results of a 'DescribeClusterParameterGroups'
-- 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.
dcpgMarker :: Lens' DescribeClusterParameterGroups (Maybe Text)
dcpgMarker = lens _dcpgMarker (\s a -> s { _dcpgMarker = 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.
dcpgMaxRecords :: Lens' DescribeClusterParameterGroups (Maybe Int)
dcpgMaxRecords = lens _dcpgMaxRecords (\s a -> s { _dcpgMaxRecords = a })

-- | The name of a specific parameter group for which to return details. By
-- default, details about all parameter groups and the default parameter group
-- are returned.
dcpgParameterGroupName :: Lens' DescribeClusterParameterGroups (Maybe Text)
dcpgParameterGroupName =
    lens _dcpgParameterGroupName (\s a -> s { _dcpgParameterGroupName = a })

-- | A tag key or keys for which you want to return all matching cluster parameter
-- groups that are associated with the specified key or keys. For example,
-- suppose that you have parameter 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 parameter groups that have either or
-- both of these tag keys associated with them.
dcpgTagKeys :: Lens' DescribeClusterParameterGroups [Text]
dcpgTagKeys = lens _dcpgTagKeys (\s a -> s { _dcpgTagKeys = a }) . _List

-- | A tag value or values for which you want to return all matching cluster
-- parameter groups that are associated with the specified tag value or values.
-- For example, suppose that you have parameter 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 parameter groups that
-- have either or both of these tag values associated with them.
dcpgTagValues :: Lens' DescribeClusterParameterGroups [Text]
dcpgTagValues = lens _dcpgTagValues (\s a -> s { _dcpgTagValues = a }) . _List

data DescribeClusterParameterGroupsResponse = DescribeClusterParameterGroupsResponse
    { _dcpgrMarker          :: Maybe Text
    , _dcpgrParameterGroups :: List "member" ClusterParameterGroup
    } deriving (Eq, Read, Show)

-- | 'DescribeClusterParameterGroupsResponse' constructor.
--
-- The fields accessible through corresponding lenses are:
--
-- * 'dcpgrMarker' @::@ 'Maybe' 'Text'
--
-- * 'dcpgrParameterGroups' @::@ ['ClusterParameterGroup']
--
describeClusterParameterGroupsResponse :: DescribeClusterParameterGroupsResponse
describeClusterParameterGroupsResponse = DescribeClusterParameterGroupsResponse
    { _dcpgrMarker          = Nothing
    , _dcpgrParameterGroups = mempty
    }

-- | 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.
dcpgrMarker :: Lens' DescribeClusterParameterGroupsResponse (Maybe Text)
dcpgrMarker = lens _dcpgrMarker (\s a -> s { _dcpgrMarker = a })

-- | A list of 'ClusterParameterGroup' instances. Each instance describes one
-- cluster parameter group.
dcpgrParameterGroups :: Lens' DescribeClusterParameterGroupsResponse [ClusterParameterGroup]
dcpgrParameterGroups =
    lens _dcpgrParameterGroups (\s a -> s { _dcpgrParameterGroups = a })
        . _List

instance ToPath DescribeClusterParameterGroups where
    toPath = const "/"

instance ToQuery DescribeClusterParameterGroups where
    toQuery DescribeClusterParameterGroups{..} = mconcat
        [ "Marker"             =? _dcpgMarker
        , "MaxRecords"         =? _dcpgMaxRecords
        , "ParameterGroupName" =? _dcpgParameterGroupName
        , "TagKeys"            =? _dcpgTagKeys
        , "TagValues"          =? _dcpgTagValues
        ]

instance ToHeaders DescribeClusterParameterGroups

instance AWSRequest DescribeClusterParameterGroups where
    type Sv DescribeClusterParameterGroups = Redshift
    type Rs DescribeClusterParameterGroups = DescribeClusterParameterGroupsResponse

    request  = post "DescribeClusterParameterGroups"
    response = xmlResponse

instance FromXML DescribeClusterParameterGroupsResponse where
    parseXML = withElement "DescribeClusterParameterGroupsResult" $ \x -> DescribeClusterParameterGroupsResponse
        <$> x .@? "Marker"
        <*> x .@? "ParameterGroups" .!@ mempty

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