GetTables.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.Glue.GetTables
-- Copyright   : (c) 2013-2017 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)
--
-- Retrieves the definitions of some or all of the tables in a given @Database@ .
--
--
module Network.AWS.Glue.GetTables
    (
    -- * Creating a Request
      getTables
    , GetTables
    -- * Request Lenses
    , gtCatalogId
    , gtNextToken
    , gtExpression
    , gtMaxResults
    , gtDatabaseName

    -- * Destructuring the Response
    , getTablesResponse
    , GetTablesResponse
    -- * Response Lenses
    , gtsrsTableList
    , gtsrsNextToken
    , gtsrsResponseStatus
    ) where

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

-- | /See:/ 'getTables' smart constructor.
data GetTables = GetTables'
  { _gtCatalogId    :: !(Maybe Text)
  , _gtNextToken    :: !(Maybe Text)
  , _gtExpression   :: !(Maybe Text)
  , _gtMaxResults   :: !(Maybe Nat)
  , _gtDatabaseName :: !Text
  } deriving (Eq, Read, Show, Data, Typeable, Generic)


-- | Creates a value of 'GetTables' with the minimum fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
-- * 'gtCatalogId' - The ID of the Data Catalog where the tables reside. If none is supplied, the AWS account ID is used by default.
--
-- * 'gtNextToken' - A continuation token, included if this is a continuation call.
--
-- * 'gtExpression' - A regular expression pattern. If present, only those tables whose names match the pattern are returned.
--
-- * 'gtMaxResults' - The maximum number of tables to return in a single response.
--
-- * 'gtDatabaseName' - The database in the catalog whose tables to list.
getTables
    :: Text -- ^ 'gtDatabaseName'
    -> GetTables
getTables pDatabaseName_ =
  GetTables'
  { _gtCatalogId = Nothing
  , _gtNextToken = Nothing
  , _gtExpression = Nothing
  , _gtMaxResults = Nothing
  , _gtDatabaseName = pDatabaseName_
  }


-- | The ID of the Data Catalog where the tables reside. If none is supplied, the AWS account ID is used by default.
gtCatalogId :: Lens' GetTables (Maybe Text)
gtCatalogId = lens _gtCatalogId (\ s a -> s{_gtCatalogId = a});

-- | A continuation token, included if this is a continuation call.
gtNextToken :: Lens' GetTables (Maybe Text)
gtNextToken = lens _gtNextToken (\ s a -> s{_gtNextToken = a});

-- | A regular expression pattern. If present, only those tables whose names match the pattern are returned.
gtExpression :: Lens' GetTables (Maybe Text)
gtExpression = lens _gtExpression (\ s a -> s{_gtExpression = a});

-- | The maximum number of tables to return in a single response.
gtMaxResults :: Lens' GetTables (Maybe Natural)
gtMaxResults = lens _gtMaxResults (\ s a -> s{_gtMaxResults = a}) . mapping _Nat;

-- | The database in the catalog whose tables to list.
gtDatabaseName :: Lens' GetTables Text
gtDatabaseName = lens _gtDatabaseName (\ s a -> s{_gtDatabaseName = a});

instance AWSRequest GetTables where
        type Rs GetTables = GetTablesResponse
        request = postJSON glue
        response
          = receiveJSON
              (\ s h x ->
                 GetTablesResponse' <$>
                   (x .?> "TableList" .!@ mempty) <*>
                     (x .?> "NextToken")
                     <*> (pure (fromEnum s)))

instance Hashable GetTables where

instance NFData GetTables where

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

instance ToJSON GetTables where
        toJSON GetTables'{..}
          = object
              (catMaybes
                 [("CatalogId" .=) <$> _gtCatalogId,
                  ("NextToken" .=) <$> _gtNextToken,
                  ("Expression" .=) <$> _gtExpression,
                  ("MaxResults" .=) <$> _gtMaxResults,
                  Just ("DatabaseName" .= _gtDatabaseName)])

instance ToPath GetTables where
        toPath = const "/"

instance ToQuery GetTables where
        toQuery = const mempty

-- | /See:/ 'getTablesResponse' smart constructor.
data GetTablesResponse = GetTablesResponse'
  { _gtsrsTableList      :: !(Maybe [Table])
  , _gtsrsNextToken      :: !(Maybe Text)
  , _gtsrsResponseStatus :: !Int
  } deriving (Eq, Read, Show, Data, Typeable, Generic)


-- | Creates a value of 'GetTablesResponse' with the minimum fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
-- * 'gtsrsTableList' - A list of the requested @Table@ objects.
--
-- * 'gtsrsNextToken' - A continuation token, present if the current list segment is not the last.
--
-- * 'gtsrsResponseStatus' - -- | The response status code.
getTablesResponse
    :: Int -- ^ 'gtsrsResponseStatus'
    -> GetTablesResponse
getTablesResponse pResponseStatus_ =
  GetTablesResponse'
  { _gtsrsTableList = Nothing
  , _gtsrsNextToken = Nothing
  , _gtsrsResponseStatus = pResponseStatus_
  }


-- | A list of the requested @Table@ objects.
gtsrsTableList :: Lens' GetTablesResponse [Table]
gtsrsTableList = lens _gtsrsTableList (\ s a -> s{_gtsrsTableList = a}) . _Default . _Coerce;

-- | A continuation token, present if the current list segment is not the last.
gtsrsNextToken :: Lens' GetTablesResponse (Maybe Text)
gtsrsNextToken = lens _gtsrsNextToken (\ s a -> s{_gtsrsNextToken = a});

-- | -- | The response status code.
gtsrsResponseStatus :: Lens' GetTablesResponse Int
gtsrsResponseStatus = lens _gtsrsResponseStatus (\ s a -> s{_gtsrsResponseStatus = a});

instance NFData GetTablesResponse where