DescribePlacementGroups.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.EC2.DescribePlacementGroups
-- 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)
--
-- Describes one or more of your placement groups. For more information about placement groups and cluster instances, see <http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using_cluster_computing.html Cluster Instances> in the /Amazon Elastic Compute Cloud User Guide/.
module Network.AWS.EC2.DescribePlacementGroups
    (
    -- * Creating a Request
      describePlacementGroups
    , DescribePlacementGroups
    -- * Request Lenses
    , dpgsFilters
    , dpgsGroupNames
    , dpgsDryRun

    -- * Destructuring the Response
    , describePlacementGroupsResponse
    , DescribePlacementGroupsResponse
    -- * Response Lenses
    , dpgrsPlacementGroups
    , dpgrsResponseStatus
    ) where

import           Network.AWS.EC2.Types
import           Network.AWS.EC2.Types.Product
import           Network.AWS.Lens
import           Network.AWS.Prelude
import           Network.AWS.Request
import           Network.AWS.Response

-- | Contains the parameters for DescribePlacementGroups.
--
-- /See:/ 'describePlacementGroups' smart constructor.
data DescribePlacementGroups = DescribePlacementGroups'
    { _dpgsFilters    :: !(Maybe [Filter])
    , _dpgsGroupNames :: !(Maybe [Text])
    , _dpgsDryRun     :: !(Maybe Bool)
    } deriving (Eq,Read,Show,Data,Typeable,Generic)

-- | Creates a value of 'DescribePlacementGroups' with the minimum fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
-- * 'dpgsFilters'
--
-- * 'dpgsGroupNames'
--
-- * 'dpgsDryRun'
describePlacementGroups
    :: DescribePlacementGroups
describePlacementGroups =
    DescribePlacementGroups'
    { _dpgsFilters = Nothing
    , _dpgsGroupNames = Nothing
    , _dpgsDryRun = Nothing
    }

-- | One or more filters.
--
-- -   'group-name' - The name of the placement group.
--
-- -   'state' - The state of the placement group ('pending' | 'available' | 'deleting' | 'deleted').
--
-- -   'strategy' - The strategy of the placement group ('cluster').
--
dpgsFilters :: Lens' DescribePlacementGroups [Filter]
dpgsFilters = lens _dpgsFilters (\ s a -> s{_dpgsFilters = a}) . _Default . _Coerce;

-- | One or more placement group names.
--
-- Default: Describes all your placement groups, or only those otherwise specified.
dpgsGroupNames :: Lens' DescribePlacementGroups [Text]
dpgsGroupNames = lens _dpgsGroupNames (\ s a -> s{_dpgsGroupNames = a}) . _Default . _Coerce;

-- | Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is 'DryRunOperation'. Otherwise, it is 'UnauthorizedOperation'.
dpgsDryRun :: Lens' DescribePlacementGroups (Maybe Bool)
dpgsDryRun = lens _dpgsDryRun (\ s a -> s{_dpgsDryRun = a});

instance AWSRequest DescribePlacementGroups where
        type Rs DescribePlacementGroups =
             DescribePlacementGroupsResponse
        request = postQuery ec2
        response
          = receiveXML
              (\ s h x ->
                 DescribePlacementGroupsResponse' <$>
                   (x .@? "placementGroupSet" .!@ mempty >>=
                      may (parseXMLList "item"))
                     <*> (pure (fromEnum s)))

instance Hashable DescribePlacementGroups

instance NFData DescribePlacementGroups

instance ToHeaders DescribePlacementGroups where
        toHeaders = const mempty

instance ToPath DescribePlacementGroups where
        toPath = const "/"

instance ToQuery DescribePlacementGroups where
        toQuery DescribePlacementGroups'{..}
          = mconcat
              ["Action" =:
                 ("DescribePlacementGroups" :: ByteString),
               "Version" =: ("2016-04-01" :: ByteString),
               toQuery (toQueryList "Filter" <$> _dpgsFilters),
               toQuery
                 (toQueryList "GroupName" <$> _dpgsGroupNames),
               "DryRun" =: _dpgsDryRun]

-- | Contains the output of DescribePlacementGroups.
--
-- /See:/ 'describePlacementGroupsResponse' smart constructor.
data DescribePlacementGroupsResponse = DescribePlacementGroupsResponse'
    { _dpgrsPlacementGroups :: !(Maybe [PlacementGroup])
    , _dpgrsResponseStatus  :: !Int
    } deriving (Eq,Read,Show,Data,Typeable,Generic)

-- | Creates a value of 'DescribePlacementGroupsResponse' with the minimum fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
-- * 'dpgrsPlacementGroups'
--
-- * 'dpgrsResponseStatus'
describePlacementGroupsResponse
    :: Int -- ^ 'dpgrsResponseStatus'
    -> DescribePlacementGroupsResponse
describePlacementGroupsResponse pResponseStatus_ =
    DescribePlacementGroupsResponse'
    { _dpgrsPlacementGroups = Nothing
    , _dpgrsResponseStatus = pResponseStatus_
    }

-- | One or more placement groups.
dpgrsPlacementGroups :: Lens' DescribePlacementGroupsResponse [PlacementGroup]
dpgrsPlacementGroups = lens _dpgrsPlacementGroups (\ s a -> s{_dpgrsPlacementGroups = a}) . _Default . _Coerce;

-- | The response status code.
dpgrsResponseStatus :: Lens' DescribePlacementGroupsResponse Int
dpgrsResponseStatus = lens _dpgrsResponseStatus (\ s a -> s{_dpgrsResponseStatus = a});

instance NFData DescribePlacementGroupsResponse