{-# 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.GameLift.DescribeFleetCapacity
-- 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)
--
-- Retrieves the current status of fleet capacity for one or more fleets. This information includes the number of instances that have been requested for the fleet and the number currently active. You can request capacity for all fleets, or specify a list of one or more fleet IDs. When requesting multiple fleets, use the pagination parameters to retrieve results as a set of sequential pages. If successful, a < FleetCapacity> object is returned for each requested fleet ID. When specifying a list of fleet IDs, attribute objects are returned only for fleets that currently exist.
--
-- Some API actions may limit the number of fleet IDs allowed in one request. If a request exceeds this limit, the request fails and the error message includes the maximum allowed.
module Network.AWS.GameLift.DescribeFleetCapacity
    (
    -- * Creating a Request
      describeFleetCapacity
    , DescribeFleetCapacity
    -- * Request Lenses
    , dfcNextToken
    , dfcLimit
    , dfcFleetIds

    -- * Destructuring the Response
    , describeFleetCapacityResponse
    , DescribeFleetCapacityResponse
    -- * Response Lenses
    , dfcrsNextToken
    , dfcrsFleetCapacity
    , dfcrsResponseStatus
    ) where

import           Network.AWS.GameLift.Types
import           Network.AWS.GameLift.Types.Product
import           Network.AWS.Lens
import           Network.AWS.Prelude
import           Network.AWS.Request
import           Network.AWS.Response

-- | Represents the input for a request action.
--
-- /See:/ 'describeFleetCapacity' smart constructor.
data DescribeFleetCapacity = DescribeFleetCapacity'
    { _dfcNextToken :: !(Maybe Text)
    , _dfcLimit     :: !(Maybe Nat)
    , _dfcFleetIds  :: !(Maybe (List1 Text))
    } deriving (Eq,Read,Show,Data,Typeable,Generic)

-- | Creates a value of 'DescribeFleetCapacity' with the minimum fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
-- * 'dfcNextToken'
--
-- * 'dfcLimit'
--
-- * 'dfcFleetIds'
describeFleetCapacity
    :: DescribeFleetCapacity
describeFleetCapacity =
    DescribeFleetCapacity'
    { _dfcNextToken = Nothing
    , _dfcLimit = Nothing
    , _dfcFleetIds = Nothing
    }

-- | Token indicating the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To specify the start of the result set, do not specify a value. This parameter is ignored when the request specifies one or a list of fleet IDs.
dfcNextToken :: Lens' DescribeFleetCapacity (Maybe Text)
dfcNextToken = lens _dfcNextToken (\ s a -> s{_dfcNextToken = a});

-- | Maximum number of results to return. Use this parameter with 'NextToken' to get results as a set of sequential pages. This parameter is ignored when the request specifies one or a list of fleet IDs.
dfcLimit :: Lens' DescribeFleetCapacity (Maybe Natural)
dfcLimit = lens _dfcLimit (\ s a -> s{_dfcLimit = a}) . mapping _Nat;

-- | Unique identifier for the fleet(s) you want to retrieve capacity information for. To request capacity information for all fleets, leave this parameter empty.
dfcFleetIds :: Lens' DescribeFleetCapacity (Maybe (NonEmpty Text))
dfcFleetIds = lens _dfcFleetIds (\ s a -> s{_dfcFleetIds = a}) . mapping _List1;

instance AWSRequest DescribeFleetCapacity where
        type Rs DescribeFleetCapacity =
             DescribeFleetCapacityResponse
        request = postJSON gameLift
        response
          = receiveJSON
              (\ s h x ->
                 DescribeFleetCapacityResponse' <$>
                   (x .?> "NextToken") <*>
                     (x .?> "FleetCapacity" .!@ mempty)
                     <*> (pure (fromEnum s)))

instance Hashable DescribeFleetCapacity

instance NFData DescribeFleetCapacity

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

instance ToJSON DescribeFleetCapacity where
        toJSON DescribeFleetCapacity'{..}
          = object
              (catMaybes
                 [("NextToken" .=) <$> _dfcNextToken,
                  ("Limit" .=) <$> _dfcLimit,
                  ("FleetIds" .=) <$> _dfcFleetIds])

instance ToPath DescribeFleetCapacity where
        toPath = const "/"

instance ToQuery DescribeFleetCapacity where
        toQuery = const mempty

-- | Represents the returned data in response to a request action.
--
-- /See:/ 'describeFleetCapacityResponse' smart constructor.
data DescribeFleetCapacityResponse = DescribeFleetCapacityResponse'
    { _dfcrsNextToken      :: !(Maybe Text)
    , _dfcrsFleetCapacity  :: !(Maybe [FleetCapacity])
    , _dfcrsResponseStatus :: !Int
    } deriving (Eq,Read,Show,Data,Typeable,Generic)

-- | Creates a value of 'DescribeFleetCapacityResponse' with the minimum fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
-- * 'dfcrsNextToken'
--
-- * 'dfcrsFleetCapacity'
--
-- * 'dfcrsResponseStatus'
describeFleetCapacityResponse
    :: Int -- ^ 'dfcrsResponseStatus'
    -> DescribeFleetCapacityResponse
describeFleetCapacityResponse pResponseStatus_ =
    DescribeFleetCapacityResponse'
    { _dfcrsNextToken = Nothing
    , _dfcrsFleetCapacity = Nothing
    , _dfcrsResponseStatus = pResponseStatus_
    }

-- | Token indicating where to resume retrieving results on the next call to this action. If no token is returned, these results represent the end of the list.
--
-- If a request has a limit that exactly matches the number of remaining results, a token is returned even though there are no more results to retrieve.
dfcrsNextToken :: Lens' DescribeFleetCapacityResponse (Maybe Text)
dfcrsNextToken = lens _dfcrsNextToken (\ s a -> s{_dfcrsNextToken = a});

-- | Collection of objects containing capacity information for each requested fleet ID. Leave this parameter empty to retrieve capacity information for all fleets.
dfcrsFleetCapacity :: Lens' DescribeFleetCapacityResponse [FleetCapacity]
dfcrsFleetCapacity = lens _dfcrsFleetCapacity (\ s a -> s{_dfcrsFleetCapacity = a}) . _Default . _Coerce;

-- | The response status code.
dfcrsResponseStatus :: Lens' DescribeFleetCapacityResponse Int
dfcrsResponseStatus = lens _dfcrsResponseStatus (\ s a -> s{_dfcrsResponseStatus = a});

instance NFData DescribeFleetCapacityResponse