GetResource.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.APIGateway.GetResource
-- Copyright   : (c) 2013-2018 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay <brendan.g.hay+amazonka@gmail.com>
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
--
-- Lists information about a resource.
--
--
module Network.AWS.APIGateway.GetResource
    (
    -- * Creating a Request
      getResource
    , GetResource
    -- * Request Lenses
    , grEmbed
    , grRestAPIId
    , grResourceId

    -- * Destructuring the Response
    , resource
    , Resource
    -- * Response Lenses
    , rPathPart
    , rPath
    , rId
    , rResourceMethods
    , rParentId
    ) where

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

-- | Request to list information about a resource.
--
--
--
-- /See:/ 'getResource' smart constructor.
data GetResource = GetResource'
  { _grEmbed      :: !(Maybe [Text])
  , _grRestAPIId  :: !Text
  , _grResourceId :: !Text
  } deriving (Eq, Read, Show, Data, Typeable, Generic)


-- | Creates a value of 'GetResource' with the minimum fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
-- * 'grEmbed' - A query parameter to retrieve the specified resources embedded in the returned 'Resource' representation in the response. This @embed@ parameter value is a list of comma-separated strings. Currently, the request supports only retrieval of the embedded 'Method' resources this way. The query parameter value must be a single-valued list and contain the @"methods"@ string. For example, @GET /restapis/{restapi_id}/resources/{resource_id}?embed=methods@ .
--
-- * 'grRestAPIId' - [Required] The string identifier of the associated 'RestApi' .
--
-- * 'grResourceId' - [Required] The identifier for the 'Resource' resource.
getResource
    :: Text -- ^ 'grRestAPIId'
    -> Text -- ^ 'grResourceId'
    -> GetResource
getResource pRestAPIId_ pResourceId_ =
  GetResource'
    { _grEmbed = Nothing
    , _grRestAPIId = pRestAPIId_
    , _grResourceId = pResourceId_
    }


-- | A query parameter to retrieve the specified resources embedded in the returned 'Resource' representation in the response. This @embed@ parameter value is a list of comma-separated strings. Currently, the request supports only retrieval of the embedded 'Method' resources this way. The query parameter value must be a single-valued list and contain the @"methods"@ string. For example, @GET /restapis/{restapi_id}/resources/{resource_id}?embed=methods@ .
grEmbed :: Lens' GetResource [Text]
grEmbed = lens _grEmbed (\ s a -> s{_grEmbed = a}) . _Default . _Coerce

-- | [Required] The string identifier of the associated 'RestApi' .
grRestAPIId :: Lens' GetResource Text
grRestAPIId = lens _grRestAPIId (\ s a -> s{_grRestAPIId = a})

-- | [Required] The identifier for the 'Resource' resource.
grResourceId :: Lens' GetResource Text
grResourceId = lens _grResourceId (\ s a -> s{_grResourceId = a})

instance AWSRequest GetResource where
        type Rs GetResource = Resource
        request = get apiGateway
        response = receiveJSON (\ s h x -> eitherParseJSON x)

instance Hashable GetResource where

instance NFData GetResource where

instance ToHeaders GetResource where
        toHeaders
          = const
              (mconcat
                 ["Accept" =# ("application/json" :: ByteString)])

instance ToPath GetResource where
        toPath GetResource'{..}
          = mconcat
              ["/restapis/", toBS _grRestAPIId, "/resources/",
               toBS _grResourceId]

instance ToQuery GetResource where
        toQuery GetResource'{..}
          = mconcat
              ["embed" =:
                 toQuery (toQueryList "member" <$> _grEmbed)]