TerminateWorkspaces.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.WorkSpaces.TerminateWorkspaces
-- 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)
--
-- Terminates the specified WorkSpaces.
--
-- Terminating a WorkSpace is a permanent action and cannot be undone. The
-- user\'s data is not maintained and will be destroyed. If you need to
-- archive any user data, contact Amazon Web Services before terminating
-- the WorkSpace.
--
-- You can terminate a WorkSpace that is in any state except 'SUSPENDED'.
--
-- This operation is asynchronous and will return before the WorkSpaces
-- have been completely terminated.
--
-- /See:/ <http://docs.aws.amazon.com/workspaces/latest/devguide/API_TerminateWorkspaces.html AWS API Reference> for TerminateWorkspaces.
module Network.AWS.WorkSpaces.TerminateWorkspaces
    (
    -- * Creating a Request
      terminateWorkspaces
    , TerminateWorkspaces
    -- * Request Lenses
    , twTerminateWorkspaceRequests

    -- * Destructuring the Response
    , terminateWorkspacesResponse
    , TerminateWorkspacesResponse
    -- * Response Lenses
    , twrsFailedRequests
    , twrsStatus
    ) where

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

-- | Contains the inputs for the TerminateWorkspaces operation.
--
-- /See:/ 'terminateWorkspaces' smart constructor.
newtype TerminateWorkspaces = TerminateWorkspaces'
    { _twTerminateWorkspaceRequests :: List1 TerminateRequest
    } deriving (Eq,Read,Show,Data,Typeable,Generic)

-- | Creates a value of 'TerminateWorkspaces' with the minimum fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
-- * 'twTerminateWorkspaceRequests'
terminateWorkspaces
    :: NonEmpty TerminateRequest -- ^ 'twTerminateWorkspaceRequests'
    -> TerminateWorkspaces
terminateWorkspaces pTerminateWorkspaceRequests_ =
    TerminateWorkspaces'
    { _twTerminateWorkspaceRequests = _List1 # pTerminateWorkspaceRequests_
    }

-- | An array of structures that specify the WorkSpaces to terminate.
twTerminateWorkspaceRequests :: Lens' TerminateWorkspaces (NonEmpty TerminateRequest)
twTerminateWorkspaceRequests = lens _twTerminateWorkspaceRequests (\ s a -> s{_twTerminateWorkspaceRequests = a}) . _List1;

instance AWSRequest TerminateWorkspaces where
        type Sv TerminateWorkspaces = WorkSpaces
        type Rs TerminateWorkspaces =
             TerminateWorkspacesResponse
        request = postJSON
        response
          = receiveJSON
              (\ s h x ->
                 TerminateWorkspacesResponse' <$>
                   (x .?> "FailedRequests" .!@ mempty) <*>
                     (pure (fromEnum s)))

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

instance ToJSON TerminateWorkspaces where
        toJSON TerminateWorkspaces'{..}
          = object
              ["TerminateWorkspaceRequests" .=
                 _twTerminateWorkspaceRequests]

instance ToPath TerminateWorkspaces where
        toPath = const "/"

instance ToQuery TerminateWorkspaces where
        toQuery = const mempty

-- | Contains the results of the TerminateWorkspaces operation.
--
-- /See:/ 'terminateWorkspacesResponse' smart constructor.
data TerminateWorkspacesResponse = TerminateWorkspacesResponse'
    { _twrsFailedRequests :: !(Maybe [FailedWorkspaceChangeRequest])
    , _twrsStatus         :: !Int
    } deriving (Eq,Read,Show,Data,Typeable,Generic)

-- | Creates a value of 'TerminateWorkspacesResponse' with the minimum fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
-- * 'twrsFailedRequests'
--
-- * 'twrsStatus'
terminateWorkspacesResponse
    :: Int -- ^ 'twrsStatus'
    -> TerminateWorkspacesResponse
terminateWorkspacesResponse pStatus_ =
    TerminateWorkspacesResponse'
    { _twrsFailedRequests = Nothing
    , _twrsStatus = pStatus_
    }

-- | An array of structures that represent any WorkSpaces that could not be
-- terminated.
twrsFailedRequests :: Lens' TerminateWorkspacesResponse [FailedWorkspaceChangeRequest]
twrsFailedRequests = lens _twrsFailedRequests (\ s a -> s{_twrsFailedRequests = a}) . _Default . _Coerce;

-- | The response status code.
twrsStatus :: Lens' TerminateWorkspacesResponse Int
twrsStatus = lens _twrsStatus (\ s a -> s{_twrsStatus = a});