DescribeVPNGateways.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.DescribeVPNGateways
-- 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 virtual private gateways.
--
-- For more information about virtual private gateways, see <http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_VPN.html Adding an IPsec Hardware VPN to Your VPC> in the /Amazon Virtual Private Cloud User Guide/.
module Network.AWS.EC2.DescribeVPNGateways
    (
    -- * Creating a Request
      describeVPNGateways
    , DescribeVPNGateways
    -- * Request Lenses
    , dvgsFilters
    , dvgsVPNGatewayIds
    , dvgsDryRun

    -- * Destructuring the Response
    , describeVPNGatewaysResponse
    , DescribeVPNGatewaysResponse
    -- * Response Lenses
    , dvgrsVPNGateways
    , dvgrsResponseStatus
    ) 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 DescribeVpnGateways.
--
-- /See:/ 'describeVPNGateways' smart constructor.
data DescribeVPNGateways = DescribeVPNGateways'
    { _dvgsFilters       :: !(Maybe [Filter])
    , _dvgsVPNGatewayIds :: !(Maybe [Text])
    , _dvgsDryRun        :: !(Maybe Bool)
    } deriving (Eq,Read,Show,Data,Typeable,Generic)

-- | Creates a value of 'DescribeVPNGateways' with the minimum fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
-- * 'dvgsFilters'
--
-- * 'dvgsVPNGatewayIds'
--
-- * 'dvgsDryRun'
describeVPNGateways
    :: DescribeVPNGateways
describeVPNGateways =
    DescribeVPNGateways'
    { _dvgsFilters = Nothing
    , _dvgsVPNGatewayIds = Nothing
    , _dvgsDryRun = Nothing
    }

-- | One or more filters.
--
-- -   'attachment.state' - The current state of the attachment between the gateway and the VPC ('attaching' | 'attached' | 'detaching' | 'detached').
--
-- -   'attachment.vpc-id' - The ID of an attached VPC.
--
-- -   'availability-zone' - The Availability Zone for the virtual private gateway (if applicable).
--
-- -   'state' - The state of the virtual private gateway ('pending' | 'available' | 'deleting' | 'deleted').
--
-- -   'tag':/key/=/value/ - The key\/value combination of a tag assigned to the resource.
--
-- -   'tag-key' - The key of a tag assigned to the resource. This filter is independent of the 'tag-value' filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag\'s value is), and the tag value X (regardless of what the tag\'s key is). If you want to list only resources where Purpose is X, see the 'tag':/key/=/value/ filter.
--
-- -   'tag-value' - The value of a tag assigned to the resource. This filter is independent of the 'tag-key' filter.
--
-- -   'type' - The type of virtual private gateway. Currently the only supported type is 'ipsec.1'.
--
-- -   'vpn-gateway-id' - The ID of the virtual private gateway.
--
dvgsFilters :: Lens' DescribeVPNGateways [Filter]
dvgsFilters = lens _dvgsFilters (\ s a -> s{_dvgsFilters = a}) . _Default . _Coerce;

-- | One or more virtual private gateway IDs.
--
-- Default: Describes all your virtual private gateways.
dvgsVPNGatewayIds :: Lens' DescribeVPNGateways [Text]
dvgsVPNGatewayIds = lens _dvgsVPNGatewayIds (\ s a -> s{_dvgsVPNGatewayIds = 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'.
dvgsDryRun :: Lens' DescribeVPNGateways (Maybe Bool)
dvgsDryRun = lens _dvgsDryRun (\ s a -> s{_dvgsDryRun = a});

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

instance Hashable DescribeVPNGateways

instance NFData DescribeVPNGateways

instance ToHeaders DescribeVPNGateways where
        toHeaders = const mempty

instance ToPath DescribeVPNGateways where
        toPath = const "/"

instance ToQuery DescribeVPNGateways where
        toQuery DescribeVPNGateways'{..}
          = mconcat
              ["Action" =: ("DescribeVpnGateways" :: ByteString),
               "Version" =: ("2015-10-01" :: ByteString),
               toQuery (toQueryList "Filter" <$> _dvgsFilters),
               toQuery
                 (toQueryList "VpnGatewayId" <$> _dvgsVPNGatewayIds),
               "DryRun" =: _dvgsDryRun]

-- | Contains the output of DescribeVpnGateways.
--
-- /See:/ 'describeVPNGatewaysResponse' smart constructor.
data DescribeVPNGatewaysResponse = DescribeVPNGatewaysResponse'
    { _dvgrsVPNGateways    :: !(Maybe [VPNGateway])
    , _dvgrsResponseStatus :: !Int
    } deriving (Eq,Read,Show,Data,Typeable,Generic)

-- | Creates a value of 'DescribeVPNGatewaysResponse' with the minimum fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
-- * 'dvgrsVPNGateways'
--
-- * 'dvgrsResponseStatus'
describeVPNGatewaysResponse
    :: Int -- ^ 'dvgrsResponseStatus'
    -> DescribeVPNGatewaysResponse
describeVPNGatewaysResponse pResponseStatus_ =
    DescribeVPNGatewaysResponse'
    { _dvgrsVPNGateways = Nothing
    , _dvgrsResponseStatus = pResponseStatus_
    }

-- | Information about one or more virtual private gateways.
dvgrsVPNGateways :: Lens' DescribeVPNGatewaysResponse [VPNGateway]
dvgrsVPNGateways = lens _dvgrsVPNGateways (\ s a -> s{_dvgrsVPNGateways = a}) . _Default . _Coerce;

-- | The response status code.
dvgrsResponseStatus :: Lens' DescribeVPNGatewaysResponse Int
dvgrsResponseStatus = lens _dvgrsResponseStatus (\ s a -> s{_dvgrsResponseStatus = a});

instance NFData DescribeVPNGatewaysResponse