DescribeSnapshotAttribute.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.DescribeSnapshotAttribute
-- 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)

-- | Describes the specified attribute of the specified snapshot. You can specify
-- only one attribute at a time.
--
-- For more information about Amazon EBS snapshots, see <http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSSnapshots.html Amazon EBS Snapshots> in
-- the /Amazon Elastic Compute Cloud User Guide/.
--
-- <http://docs.aws.amazon.com/AWSEC2/latest/APIReference/ApiReference-query-DescribeSnapshotAttribute.html>
module Network.AWS.EC2.DescribeSnapshotAttribute
    (
    -- * Request
      DescribeSnapshotAttribute
    -- ** Request constructor
    , describeSnapshotAttribute
    -- ** Request lenses
    , dsaAttribute
    , dsaDryRun
    , dsaSnapshotId

    -- * Response
    , DescribeSnapshotAttributeResponse
    -- ** Response constructor
    , describeSnapshotAttributeResponse
    -- ** Response lenses
    , dsarCreateVolumePermissions
    , dsarProductCodes
    , dsarSnapshotId
    ) where

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

data DescribeSnapshotAttribute = DescribeSnapshotAttribute
    { _dsaAttribute  :: SnapshotAttributeName
    , _dsaDryRun     :: Maybe Bool
    , _dsaSnapshotId :: Text
    } deriving (Eq, Show)

-- | 'DescribeSnapshotAttribute' constructor.
--
-- The fields accessible through corresponding lenses are:
--
-- * 'dsaAttribute' @::@ 'SnapshotAttributeName'
--
-- * 'dsaDryRun' @::@ 'Maybe' 'Bool'
--
-- * 'dsaSnapshotId' @::@ 'Text'
--
describeSnapshotAttribute :: Text -- ^ 'dsaSnapshotId'
                          -> SnapshotAttributeName -- ^ 'dsaAttribute'
                          -> DescribeSnapshotAttribute
describeSnapshotAttribute p1 p2 = DescribeSnapshotAttribute
    { _dsaSnapshotId = p1
    , _dsaAttribute  = p2
    , _dsaDryRun     = Nothing
    }

-- | The snapshot attribute you would like to view.
dsaAttribute :: Lens' DescribeSnapshotAttribute SnapshotAttributeName
dsaAttribute = lens _dsaAttribute (\s a -> s { _dsaAttribute = a })

dsaDryRun :: Lens' DescribeSnapshotAttribute (Maybe Bool)
dsaDryRun = lens _dsaDryRun (\s a -> s { _dsaDryRun = a })

-- | The ID of the Amazon EBS snapshot.
dsaSnapshotId :: Lens' DescribeSnapshotAttribute Text
dsaSnapshotId = lens _dsaSnapshotId (\s a -> s { _dsaSnapshotId = a })

data DescribeSnapshotAttributeResponse = DescribeSnapshotAttributeResponse
    { _dsarCreateVolumePermissions :: List "item" CreateVolumePermission
    , _dsarProductCodes            :: List "item" ProductCode
    , _dsarSnapshotId              :: Maybe Text
    } deriving (Eq, Show)

-- | 'DescribeSnapshotAttributeResponse' constructor.
--
-- The fields accessible through corresponding lenses are:
--
-- * 'dsarCreateVolumePermissions' @::@ ['CreateVolumePermission']
--
-- * 'dsarProductCodes' @::@ ['ProductCode']
--
-- * 'dsarSnapshotId' @::@ 'Maybe' 'Text'
--
describeSnapshotAttributeResponse :: DescribeSnapshotAttributeResponse
describeSnapshotAttributeResponse = DescribeSnapshotAttributeResponse
    { _dsarSnapshotId              = Nothing
    , _dsarCreateVolumePermissions = mempty
    , _dsarProductCodes            = mempty
    }

-- | A list of permissions for creating volumes from the snapshot.
dsarCreateVolumePermissions :: Lens' DescribeSnapshotAttributeResponse [CreateVolumePermission]
dsarCreateVolumePermissions =
    lens _dsarCreateVolumePermissions
        (\s a -> s { _dsarCreateVolumePermissions = a })
            . _List

-- | A list of product codes.
dsarProductCodes :: Lens' DescribeSnapshotAttributeResponse [ProductCode]
dsarProductCodes = lens _dsarProductCodes (\s a -> s { _dsarProductCodes = a }) . _List

-- | The ID of the Amazon EBS snapshot.
dsarSnapshotId :: Lens' DescribeSnapshotAttributeResponse (Maybe Text)
dsarSnapshotId = lens _dsarSnapshotId (\s a -> s { _dsarSnapshotId = a })

instance ToPath DescribeSnapshotAttribute where
    toPath = const "/"

instance ToQuery DescribeSnapshotAttribute where
    toQuery DescribeSnapshotAttribute{..} = mconcat
        [ "Attribute"  =? _dsaAttribute
        , "dryRun"     =? _dsaDryRun
        , "SnapshotId" =? _dsaSnapshotId
        ]

instance ToHeaders DescribeSnapshotAttribute

instance AWSRequest DescribeSnapshotAttribute where
    type Sv DescribeSnapshotAttribute = EC2
    type Rs DescribeSnapshotAttribute = DescribeSnapshotAttributeResponse

    request  = post "DescribeSnapshotAttribute"
    response = xmlResponse

instance FromXML DescribeSnapshotAttributeResponse where
    parseXML x = DescribeSnapshotAttributeResponse
        <$> x .@  "createVolumePermission"
        <*> x .@  "productCodes"
        <*> x .@? "snapshotId"