ListHSMs.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.CloudHSM.ListHSMs
-- Copyright   : (c) 2013-2015 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)
--
-- Retrieves the identifiers of all of the HSMs provisioned for the current
-- customer.
--
-- This operation supports pagination with the use of the /NextToken/
-- member. If more results are available, the /NextToken/ member of the
-- response contains a token that you pass in the next call to ListHsms to
-- retrieve the next set of items.
--
-- /See:/ <http://docs.aws.amazon.com/cloudhsm/latest/dg/API_ListHSMs.html AWS API Reference> for ListHSMs.
module Network.AWS.CloudHSM.ListHSMs
    (
    -- * Creating a Request
      listHSMs
    , ListHSMs
    -- * Request Lenses
    , lhsmNextToken

    -- * Destructuring the Response
    , listHSMsResponse
    , ListHSMsResponse
    -- * Response Lenses
    , lhsmrsNextToken
    , lhsmrsHSMList
    , lhsmrsStatus
    ) where

import           Network.AWS.CloudHSM.Types
import           Network.AWS.CloudHSM.Types.Product
import           Network.AWS.Prelude
import           Network.AWS.Request
import           Network.AWS.Response

-- | /See:/ 'listHSMs' smart constructor.
newtype ListHSMs = ListHSMs'
    { _lhsmNextToken :: Maybe Text
    } deriving (Eq,Read,Show,Data,Typeable,Generic)

-- | Creates a value of 'ListHSMs' with the minimum fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
-- * 'lhsmNextToken'
listHSMs
    :: ListHSMs
listHSMs =
    ListHSMs'
    { _lhsmNextToken = Nothing
    }

-- | The /NextToken/ value from a previous call to ListHsms. Pass null if
-- this is the first call.
lhsmNextToken :: Lens' ListHSMs (Maybe Text)
lhsmNextToken = lens _lhsmNextToken (\ s a -> s{_lhsmNextToken = a});

instance AWSRequest ListHSMs where
        type Sv ListHSMs = CloudHSM
        type Rs ListHSMs = ListHSMsResponse
        request = postJSON
        response
          = receiveJSON
              (\ s h x ->
                 ListHSMsResponse' <$>
                   (x .?> "NextToken") <*> (x .?> "HsmList" .!@ mempty)
                     <*> (pure (fromEnum s)))

instance ToHeaders ListHSMs where
        toHeaders
          = const
              (mconcat
                 ["X-Amz-Target" =#
                    ("CloudHsmFrontendService.ListHsms" :: ByteString),
                  "Content-Type" =#
                    ("application/x-amz-json-1.1" :: ByteString)])

instance ToJSON ListHSMs where
        toJSON ListHSMs'{..}
          = object ["NextToken" .= _lhsmNextToken]

instance ToPath ListHSMs where
        toPath = const "/"

instance ToQuery ListHSMs where
        toQuery = const mempty

-- | Contains the output of the ListHsms action.
--
-- /See:/ 'listHSMsResponse' smart constructor.
data ListHSMsResponse = ListHSMsResponse'
    { _lhsmrsNextToken :: !(Maybe Text)
    , _lhsmrsHSMList   :: !(Maybe [Text])
    , _lhsmrsStatus    :: !Int
    } deriving (Eq,Read,Show,Data,Typeable,Generic)

-- | Creates a value of 'ListHSMsResponse' with the minimum fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
-- * 'lhsmrsNextToken'
--
-- * 'lhsmrsHSMList'
--
-- * 'lhsmrsStatus'
listHSMsResponse
    :: Int -- ^ 'lhsmrsStatus'
    -> ListHSMsResponse
listHSMsResponse pStatus_ =
    ListHSMsResponse'
    { _lhsmrsNextToken = Nothing
    , _lhsmrsHSMList = Nothing
    , _lhsmrsStatus = pStatus_
    }

-- | If not null, more results are available. Pass this value to ListHsms to
-- retrieve the next set of items.
lhsmrsNextToken :: Lens' ListHSMsResponse (Maybe Text)
lhsmrsNextToken = lens _lhsmrsNextToken (\ s a -> s{_lhsmrsNextToken = a});

-- | The list of ARNs that identify the HSMs.
lhsmrsHSMList :: Lens' ListHSMsResponse [Text]
lhsmrsHSMList = lens _lhsmrsHSMList (\ s a -> s{_lhsmrsHSMList = a}) . _Default . _Coerce;

-- | The response status code.
lhsmrsStatus :: Lens' ListHSMsResponse Int
lhsmrsStatus = lens _lhsmrsStatus (\ s a -> s{_lhsmrsStatus = a});