{-# 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.GetPartitions -- Copyright : (c) 2013-2017 Brendan Hay -- License : Mozilla Public License, v. 2.0. -- Maintainer : Brendan Hay -- Stability : auto-generated -- Portability : non-portable (GHC extensions) -- -- Retrieves information about the partitions in a table. -- -- module Network.AWS.Glue.GetPartitions ( -- * Creating a Request getPartitions , GetPartitions -- * Request Lenses , gpsCatalogId , gpsNextToken , gpsExpression , gpsSegment , gpsMaxResults , gpsDatabaseName , gpsTableName -- * Destructuring the Response , getPartitionsResponse , GetPartitionsResponse -- * Response Lenses , gpsrsPartitions , gpsrsNextToken , gpsrsResponseStatus ) 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:/ 'getPartitions' smart constructor. data GetPartitions = GetPartitions' { _gpsCatalogId :: !(Maybe Text) , _gpsNextToken :: !(Maybe Text) , _gpsExpression :: !(Maybe Text) , _gpsSegment :: !(Maybe Segment) , _gpsMaxResults :: !(Maybe Nat) , _gpsDatabaseName :: !Text , _gpsTableName :: !Text } deriving (Eq, Read, Show, Data, Typeable, Generic) -- | Creates a value of 'GetPartitions' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: -- -- * 'gpsCatalogId' - The ID of the Data Catalog where the partitions in question reside. If none is supplied, the AWS account ID is used by default. -- -- * 'gpsNextToken' - A continuation token, if this is not the first call to retrieve these partitions. -- -- * 'gpsExpression' - An expression filtering the partitions to be returned. -- -- * 'gpsSegment' - The segment of the table's partitions to scan in this request. -- -- * 'gpsMaxResults' - The maximum number of partitions to return in a single response. -- -- * 'gpsDatabaseName' - The name of the catalog database where the partitions reside. -- -- * 'gpsTableName' - The name of the partitions' table. getPartitions :: Text -- ^ 'gpsDatabaseName' -> Text -- ^ 'gpsTableName' -> GetPartitions getPartitions pDatabaseName_ pTableName_ = GetPartitions' { _gpsCatalogId = Nothing , _gpsNextToken = Nothing , _gpsExpression = Nothing , _gpsSegment = Nothing , _gpsMaxResults = Nothing , _gpsDatabaseName = pDatabaseName_ , _gpsTableName = pTableName_ } -- | The ID of the Data Catalog where the partitions in question reside. If none is supplied, the AWS account ID is used by default. gpsCatalogId :: Lens' GetPartitions (Maybe Text) gpsCatalogId = lens _gpsCatalogId (\ s a -> s{_gpsCatalogId = a}); -- | A continuation token, if this is not the first call to retrieve these partitions. gpsNextToken :: Lens' GetPartitions (Maybe Text) gpsNextToken = lens _gpsNextToken (\ s a -> s{_gpsNextToken = a}); -- | An expression filtering the partitions to be returned. gpsExpression :: Lens' GetPartitions (Maybe Text) gpsExpression = lens _gpsExpression (\ s a -> s{_gpsExpression = a}); -- | The segment of the table's partitions to scan in this request. gpsSegment :: Lens' GetPartitions (Maybe Segment) gpsSegment = lens _gpsSegment (\ s a -> s{_gpsSegment = a}); -- | The maximum number of partitions to return in a single response. gpsMaxResults :: Lens' GetPartitions (Maybe Natural) gpsMaxResults = lens _gpsMaxResults (\ s a -> s{_gpsMaxResults = a}) . mapping _Nat; -- | The name of the catalog database where the partitions reside. gpsDatabaseName :: Lens' GetPartitions Text gpsDatabaseName = lens _gpsDatabaseName (\ s a -> s{_gpsDatabaseName = a}); -- | The name of the partitions' table. gpsTableName :: Lens' GetPartitions Text gpsTableName = lens _gpsTableName (\ s a -> s{_gpsTableName = a}); instance AWSRequest GetPartitions where type Rs GetPartitions = GetPartitionsResponse request = postJSON glue response = receiveJSON (\ s h x -> GetPartitionsResponse' <$> (x .?> "Partitions" .!@ mempty) <*> (x .?> "NextToken") <*> (pure (fromEnum s))) instance Hashable GetPartitions where instance NFData GetPartitions where instance ToHeaders GetPartitions where toHeaders = const (mconcat ["X-Amz-Target" =# ("AWSGlue.GetPartitions" :: ByteString), "Content-Type" =# ("application/x-amz-json-1.1" :: ByteString)]) instance ToJSON GetPartitions where toJSON GetPartitions'{..} = object (catMaybes [("CatalogId" .=) <$> _gpsCatalogId, ("NextToken" .=) <$> _gpsNextToken, ("Expression" .=) <$> _gpsExpression, ("Segment" .=) <$> _gpsSegment, ("MaxResults" .=) <$> _gpsMaxResults, Just ("DatabaseName" .= _gpsDatabaseName), Just ("TableName" .= _gpsTableName)]) instance ToPath GetPartitions where toPath = const "/" instance ToQuery GetPartitions where toQuery = const mempty -- | /See:/ 'getPartitionsResponse' smart constructor. data GetPartitionsResponse = GetPartitionsResponse' { _gpsrsPartitions :: !(Maybe [Partition]) , _gpsrsNextToken :: !(Maybe Text) , _gpsrsResponseStatus :: !Int } deriving (Eq, Read, Show, Data, Typeable, Generic) -- | Creates a value of 'GetPartitionsResponse' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: -- -- * 'gpsrsPartitions' - A list of requested partitions. -- -- * 'gpsrsNextToken' - A continuation token, if the returned list of partitions does not does not include the last one. -- -- * 'gpsrsResponseStatus' - -- | The response status code. getPartitionsResponse :: Int -- ^ 'gpsrsResponseStatus' -> GetPartitionsResponse getPartitionsResponse pResponseStatus_ = GetPartitionsResponse' { _gpsrsPartitions = Nothing , _gpsrsNextToken = Nothing , _gpsrsResponseStatus = pResponseStatus_ } -- | A list of requested partitions. gpsrsPartitions :: Lens' GetPartitionsResponse [Partition] gpsrsPartitions = lens _gpsrsPartitions (\ s a -> s{_gpsrsPartitions = a}) . _Default . _Coerce; -- | A continuation token, if the returned list of partitions does not does not include the last one. gpsrsNextToken :: Lens' GetPartitionsResponse (Maybe Text) gpsrsNextToken = lens _gpsrsNextToken (\ s a -> s{_gpsrsNextToken = a}); -- | -- | The response status code. gpsrsResponseStatus :: Lens' GetPartitionsResponse Int gpsrsResponseStatus = lens _gpsrsResponseStatus (\ s a -> s{_gpsrsResponseStatus = a}); instance NFData GetPartitionsResponse where