DescribeMovingAddresses.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.EC2.DescribeMovingAddresses
-- 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.

-- | Describes your Elastic IP addresses that are being moved to the EC2-VPC
-- platform, or that are being restored to the EC2-Classic platform. This
-- request does not return information about any other Elastic IP addresses in
-- your account.
--
-- <http://docs.aws.amazon.com/AWSEC2/latest/APIReference/ApiReference-query-DescribeMovingAddresses.html>
module Network.AWS.EC2.DescribeMovingAddresses
    (
    -- * Request
      DescribeMovingAddresses
    -- ** Request constructor
    , describeMovingAddresses
    -- ** Request lenses
    , dmaDryRun
    , dmaFilters
    , dmaMaxResults
    , dmaNextToken
    , dmaPublicIps

    -- * Response
    , DescribeMovingAddressesResponse
    -- ** Response constructor
    , describeMovingAddressesResponse
    -- ** Response lenses
    , dmarMovingAddressStatuses
    , dmarNextToken
    ) where

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

data DescribeMovingAddresses = DescribeMovingAddresses
    { _dmaDryRun     :: Maybe Bool
    , _dmaFilters    :: List "Filter" Filter
    , _dmaMaxResults :: Maybe Int
    , _dmaNextToken  :: Maybe Text
    , _dmaPublicIps  :: List "item" Text
    } deriving (Eq, Read, Show)

-- | 'DescribeMovingAddresses' constructor.
--
-- The fields accessible through corresponding lenses are:
--
-- * 'dmaDryRun' @::@ 'Maybe' 'Bool'
--
-- * 'dmaFilters' @::@ ['Filter']
--
-- * 'dmaMaxResults' @::@ 'Maybe' 'Int'
--
-- * 'dmaNextToken' @::@ 'Maybe' 'Text'
--
-- * 'dmaPublicIps' @::@ ['Text']
--
describeMovingAddresses :: DescribeMovingAddresses
describeMovingAddresses = DescribeMovingAddresses
    { _dmaDryRun     = Nothing
    , _dmaPublicIps  = mempty
    , _dmaNextToken  = Nothing
    , _dmaFilters    = mempty
    , _dmaMaxResults = Nothing
    }

-- | 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'.
dmaDryRun :: Lens' DescribeMovingAddresses (Maybe Bool)
dmaDryRun = lens _dmaDryRun (\s a -> s { _dmaDryRun = a })

-- | One or more filters.
--
-- 'moving-status' - The status of the Elastic IP address ('MovingToVpc' | 'RestoringToClassic').
--
--
dmaFilters :: Lens' DescribeMovingAddresses [Filter]
dmaFilters = lens _dmaFilters (\s a -> s { _dmaFilters = a }) . _List

-- | The maximum number of results to return for the request in a single page. The
-- remaining results of the initial request can be seen by sending another
-- request with the returned 'NextToken' value. This value can be between 5 and
-- 1000; if 'MaxResults' is given a value outside of this range, an error is
-- returned.
--
-- Default: If no value is provided, the default is 1000.
dmaMaxResults :: Lens' DescribeMovingAddresses (Maybe Int)
dmaMaxResults = lens _dmaMaxResults (\s a -> s { _dmaMaxResults = a })

-- | The token to use to retrieve the next page of results.
dmaNextToken :: Lens' DescribeMovingAddresses (Maybe Text)
dmaNextToken = lens _dmaNextToken (\s a -> s { _dmaNextToken = a })

-- | One or more Elastic IP addresses.
dmaPublicIps :: Lens' DescribeMovingAddresses [Text]
dmaPublicIps = lens _dmaPublicIps (\s a -> s { _dmaPublicIps = a }) . _List

data DescribeMovingAddressesResponse = DescribeMovingAddressesResponse
    { _dmarMovingAddressStatuses :: List "item" MovingAddressStatus
    , _dmarNextToken             :: Maybe Text
    } deriving (Eq, Read, Show)

-- | 'DescribeMovingAddressesResponse' constructor.
--
-- The fields accessible through corresponding lenses are:
--
-- * 'dmarMovingAddressStatuses' @::@ ['MovingAddressStatus']
--
-- * 'dmarNextToken' @::@ 'Maybe' 'Text'
--
describeMovingAddressesResponse :: DescribeMovingAddressesResponse
describeMovingAddressesResponse = DescribeMovingAddressesResponse
    { _dmarMovingAddressStatuses = mempty
    , _dmarNextToken             = Nothing
    }

-- | The status for each Elastic IP address.
dmarMovingAddressStatuses :: Lens' DescribeMovingAddressesResponse [MovingAddressStatus]
dmarMovingAddressStatuses =
    lens _dmarMovingAddressStatuses
        (\s a -> s { _dmarMovingAddressStatuses = a })
            . _List

-- | The token to use to retrieve the next page of results. This value is 'null'
-- when there are no more results to return.
dmarNextToken :: Lens' DescribeMovingAddressesResponse (Maybe Text)
dmarNextToken = lens _dmarNextToken (\s a -> s { _dmarNextToken = a })

instance ToPath DescribeMovingAddresses where
    toPath = const "/"

instance ToQuery DescribeMovingAddresses where
    toQuery DescribeMovingAddresses{..} = mconcat
        [ "DryRun"     =? _dmaDryRun
        , "Filter"     `toQueryList` _dmaFilters
        , "MaxResults" =? _dmaMaxResults
        , "NextToken"  =? _dmaNextToken
        , "PublicIp"   `toQueryList` _dmaPublicIps
        ]

instance ToHeaders DescribeMovingAddresses

instance AWSRequest DescribeMovingAddresses where
    type Sv DescribeMovingAddresses = EC2
    type Rs DescribeMovingAddresses = DescribeMovingAddressesResponse

    request  = post "DescribeMovingAddresses"
    response = xmlResponse

instance FromXML DescribeMovingAddressesResponse where
    parseXML x = DescribeMovingAddressesResponse
        <$> x .@? "movingAddressStatusSet" .!@ mempty
        <*> x .@? "nextToken"