DescribeDataSources.hs

{-# LANGUAGE DataKinds                   #-}
{-# LANGUAGE DeriveGeneric               #-}
{-# LANGUAGE FlexibleInstances           #-}
{-# LANGUAGE GeneralizedNewtypeDeriving  #-}
{-# LANGUAGE LambdaCase                  #-}
{-# LANGUAGE NoImplicitPrelude           #-}
{-# LANGUAGE OverloadedStrings           #-}
{-# LANGUAGE RecordWildCards             #-}
{-# LANGUAGE TypeFamilies                #-}

{-# OPTIONS_GHC -fno-warn-unused-imports #-}

-- Module      : Network.AWS.MachineLearning.DescribeDataSources
-- Copyright   : (c) 2013-2014 Brendan Hay <brendan.g.hay@gmail.com>
-- License     : This Source Code Form is subject to the terms of
--               the Mozilla Public License, v. 2.0.
--               A copy of the MPL can be found in the LICENSE file or
--               you can obtain it at http://mozilla.org/MPL/2.0/.
-- Maintainer  : Brendan Hay <brendan.g.hay@gmail.com>
-- Stability   : experimental
-- Portability : non-portable (GHC extensions)
--
-- Derived from AWS service descriptions, licensed under Apache 2.0.

-- | Returns a list of 'DataSource' that match the search criteria in the request.
--
-- <http://http://docs.aws.amazon.com/machine-learning/latest/APIReference/API_DescribeDataSources.html>
module Network.AWS.MachineLearning.DescribeDataSources
    (
    -- * Request
      DescribeDataSources
    -- ** Request constructor
    , describeDataSources
    -- ** Request lenses
    , ddsEQ
    , ddsFilterVariable
    , ddsGE
    , ddsGT
    , ddsLE
    , ddsLT
    , ddsLimit
    , ddsNE
    , ddsNextToken
    , ddsPrefix
    , ddsSortOrder

    -- * Response
    , DescribeDataSourcesResponse
    -- ** Response constructor
    , describeDataSourcesResponse
    -- ** Response lenses
    , ddsrNextToken
    , ddsrResults
    ) where

import Network.AWS.Data (Object)
import Network.AWS.Prelude
import Network.AWS.Request.JSON
import Network.AWS.MachineLearning.Types
import qualified GHC.Exts

data DescribeDataSources = DescribeDataSources
    { _ddsEQ             :: Maybe Text
    , _ddsFilterVariable :: Maybe DataSourceFilterVariable
    , _ddsGE             :: Maybe Text
    , _ddsGT             :: Maybe Text
    , _ddsLE             :: Maybe Text
    , _ddsLT             :: Maybe Text
    , _ddsLimit          :: Maybe Nat
    , _ddsNE             :: Maybe Text
    , _ddsNextToken      :: Maybe Text
    , _ddsPrefix         :: Maybe Text
    , _ddsSortOrder      :: Maybe SortOrder
    } deriving (Eq, Read, Show)

-- | 'DescribeDataSources' constructor.
--
-- The fields accessible through corresponding lenses are:
--
-- * 'ddsEQ' @::@ 'Maybe' 'Text'
--
-- * 'ddsFilterVariable' @::@ 'Maybe' 'DataSourceFilterVariable'
--
-- * 'ddsGE' @::@ 'Maybe' 'Text'
--
-- * 'ddsGT' @::@ 'Maybe' 'Text'
--
-- * 'ddsLE' @::@ 'Maybe' 'Text'
--
-- * 'ddsLT' @::@ 'Maybe' 'Text'
--
-- * 'ddsLimit' @::@ 'Maybe' 'Natural'
--
-- * 'ddsNE' @::@ 'Maybe' 'Text'
--
-- * 'ddsNextToken' @::@ 'Maybe' 'Text'
--
-- * 'ddsPrefix' @::@ 'Maybe' 'Text'
--
-- * 'ddsSortOrder' @::@ 'Maybe' 'SortOrder'
--
describeDataSources :: DescribeDataSources
describeDataSources = DescribeDataSources
    { _ddsFilterVariable = Nothing
    , _ddsEQ             = Nothing
    , _ddsGT             = Nothing
    , _ddsLT             = Nothing
    , _ddsGE             = Nothing
    , _ddsLE             = Nothing
    , _ddsNE             = Nothing
    , _ddsPrefix         = Nothing
    , _ddsSortOrder      = Nothing
    , _ddsNextToken      = Nothing
    , _ddsLimit          = Nothing
    }

-- | The equal to operator. The 'DataSource' results will have 'FilterVariable' values
-- that exactly match the value specified with 'EQ'.
ddsEQ :: Lens' DescribeDataSources (Maybe Text)
ddsEQ = lens _ddsEQ (\s a -> s { _ddsEQ = a })

-- | Use one of the following variables to filter a list of 'DataSource':
--
-- 'CreatedAt' - Sets the search criteria to 'DataSource' creation dates.  'Status'
-- - Sets the search criteria to 'DataSource' statuses.  'Name' - Sets the search
-- criteria to the contents of 'DataSource'   'Name'.  'DataUri' - Sets the search
-- criteria to the URI of data files used to create the 'DataSource'. The URI can
-- identify either a file or an Amazon Simple Storage Service (Amazon S3) bucket
-- or directory.  'IAMUser' - Sets the search criteria to the user account that
-- invoked the 'DataSource' creation.
ddsFilterVariable :: Lens' DescribeDataSources (Maybe DataSourceFilterVariable)
ddsFilterVariable =
    lens _ddsFilterVariable (\s a -> s { _ddsFilterVariable = a })

-- | The greater than or equal to operator. The 'DataSource' results will have 'FilterVariable' values that are greater than or equal to the value specified with 'GE'.
ddsGE :: Lens' DescribeDataSources (Maybe Text)
ddsGE = lens _ddsGE (\s a -> s { _ddsGE = a })

-- | The greater than operator. The 'DataSource' results will have 'FilterVariable'
-- values that are greater than the value specified with 'GT'.
ddsGT :: Lens' DescribeDataSources (Maybe Text)
ddsGT = lens _ddsGT (\s a -> s { _ddsGT = a })

-- | The less than or equal to operator. The 'DataSource' results will have 'FilterVariable' values that are less than or equal to the value specified with 'LE'.
ddsLE :: Lens' DescribeDataSources (Maybe Text)
ddsLE = lens _ddsLE (\s a -> s { _ddsLE = a })

-- | The less than operator. The 'DataSource' results will have 'FilterVariable'
-- values that are less than the value specified with 'LT'.
ddsLT :: Lens' DescribeDataSources (Maybe Text)
ddsLT = lens _ddsLT (\s a -> s { _ddsLT = a })

-- | The maximum number of 'DataSource' to include in the result.
ddsLimit :: Lens' DescribeDataSources (Maybe Natural)
ddsLimit = lens _ddsLimit (\s a -> s { _ddsLimit = a }) . mapping _Nat

-- | The not equal to operator. The 'DataSource' results will have 'FilterVariable'
-- values not equal to the value specified with 'NE'.
ddsNE :: Lens' DescribeDataSources (Maybe Text)
ddsNE = lens _ddsNE (\s a -> s { _ddsNE = a })

-- | The ID of the page in the paginated results.
ddsNextToken :: Lens' DescribeDataSources (Maybe Text)
ddsNextToken = lens _ddsNextToken (\s a -> s { _ddsNextToken = a })

-- | A string that is found at the beginning of a variable, such as 'Name' or 'Id'.
--
-- For example, a 'DataSource' could have the 'Name' '2014-09-09-HolidayGiftMailer'.
-- To search for this 'DataSource', select 'Name' for the 'FilterVariable' and any of
-- the following strings for the 'Prefix':
--
-- 2014-09
--
-- 2014-09-09
--
-- 2014-09-09-Holiday
--
--
ddsPrefix :: Lens' DescribeDataSources (Maybe Text)
ddsPrefix = lens _ddsPrefix (\s a -> s { _ddsPrefix = a })

-- | A two-value parameter that determines the sequence of the resulting list of 'DataSource'.
--
-- 'asc' - Arranges the list in ascending order (A-Z, 0-9).  'dsc' - Arranges the
-- list in descending order (Z-A, 9-0).  Results are sorted by 'FilterVariable'.
ddsSortOrder :: Lens' DescribeDataSources (Maybe SortOrder)
ddsSortOrder = lens _ddsSortOrder (\s a -> s { _ddsSortOrder = a })

data DescribeDataSourcesResponse = DescribeDataSourcesResponse
    { _ddsrNextToken :: Maybe Text
    , _ddsrResults   :: List "Results" DataSource
    } deriving (Eq, Read, Show)

-- | 'DescribeDataSourcesResponse' constructor.
--
-- The fields accessible through corresponding lenses are:
--
-- * 'ddsrNextToken' @::@ 'Maybe' 'Text'
--
-- * 'ddsrResults' @::@ ['DataSource']
--
describeDataSourcesResponse :: DescribeDataSourcesResponse
describeDataSourcesResponse = DescribeDataSourcesResponse
    { _ddsrResults   = mempty
    , _ddsrNextToken = Nothing
    }

-- | An ID of the next page in the paginated results that indicates at least one
-- more page follows.
ddsrNextToken :: Lens' DescribeDataSourcesResponse (Maybe Text)
ddsrNextToken = lens _ddsrNextToken (\s a -> s { _ddsrNextToken = a })

-- | A list of 'DataSource' that meet the search criteria.
ddsrResults :: Lens' DescribeDataSourcesResponse [DataSource]
ddsrResults = lens _ddsrResults (\s a -> s { _ddsrResults = a }) . _List

instance ToPath DescribeDataSources where
    toPath = const "/"

instance ToQuery DescribeDataSources where
    toQuery = const mempty

instance ToHeaders DescribeDataSources

instance ToJSON DescribeDataSources where
    toJSON DescribeDataSources{..} = object
        [ "FilterVariable" .= _ddsFilterVariable
        , "EQ"             .= _ddsEQ
        , "GT"             .= _ddsGT
        , "LT"             .= _ddsLT
        , "GE"             .= _ddsGE
        , "LE"             .= _ddsLE
        , "NE"             .= _ddsNE
        , "Prefix"         .= _ddsPrefix
        , "SortOrder"      .= _ddsSortOrder
        , "NextToken"      .= _ddsNextToken
        , "Limit"          .= _ddsLimit
        ]

instance AWSRequest DescribeDataSources where
    type Sv DescribeDataSources = MachineLearning
    type Rs DescribeDataSources = DescribeDataSourcesResponse

    request  = post "DescribeDataSources"
    response = jsonResponse

instance FromJSON DescribeDataSourcesResponse where
    parseJSON = withObject "DescribeDataSourcesResponse" $ \o -> DescribeDataSourcesResponse
        <$> o .:? "NextToken"
        <*> o .:? "Results" .!= mempty

instance AWSPager DescribeDataSources where
    page rq rs
        | stop (rs ^. ddsrNextToken) = Nothing
        | otherwise = (\x -> rq & ddsNextToken ?~ x)
            <$> (rs ^. ddsrNextToken)