{-# 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.CloudSearch.DescribeDomains -- Copyright : (c) 2013-2018 Brendan Hay -- License : Mozilla Public License, v. 2.0. -- Maintainer : Brendan Hay -- Stability : auto-generated -- Portability : non-portable (GHC extensions) -- -- Gets information about the search domains owned by this account. Can be limited to specific domains. Shows all domains by default. To get the number of searchable documents in a domain, use the console or submit a @matchall@ request to your domain's search endpoint: @q=matchall&q.parser=structured&size=0@ . For more information, see in the /Amazon CloudSearch Developer Guide/ . -- -- module Network.AWS.CloudSearch.DescribeDomains ( -- * Creating a Request describeDomains , DescribeDomains -- * Request Lenses , ddDomainNames -- * Destructuring the Response , describeDomainsResponse , DescribeDomainsResponse -- * Response Lenses , ddsrsResponseStatus , ddsrsDomainStatusList ) where import Network.AWS.CloudSearch.Types import Network.AWS.CloudSearch.Types.Product import Network.AWS.Lens import Network.AWS.Prelude import Network.AWS.Request import Network.AWS.Response -- | Container for the parameters to the @'DescribeDomains' @ operation. By default shows the status of all domains. To restrict the response to particular domains, specify the names of the domains you want to describe. -- -- -- -- /See:/ 'describeDomains' smart constructor. newtype DescribeDomains = DescribeDomains' { _ddDomainNames :: Maybe [Text] } deriving (Eq, Read, Show, Data, Typeable, Generic) -- | Creates a value of 'DescribeDomains' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: -- -- * 'ddDomainNames' - The names of the domains you want to include in the response. describeDomains :: DescribeDomains describeDomains = DescribeDomains' {_ddDomainNames = Nothing} -- | The names of the domains you want to include in the response. ddDomainNames :: Lens' DescribeDomains [Text] ddDomainNames = lens _ddDomainNames (\ s a -> s{_ddDomainNames = a}) . _Default . _Coerce instance AWSRequest DescribeDomains where type Rs DescribeDomains = DescribeDomainsResponse request = postQuery cloudSearch response = receiveXMLWrapper "DescribeDomainsResult" (\ s h x -> DescribeDomainsResponse' <$> (pure (fromEnum s)) <*> (x .@? "DomainStatusList" .!@ mempty >>= parseXMLList "member")) instance Hashable DescribeDomains where instance NFData DescribeDomains where instance ToHeaders DescribeDomains where toHeaders = const mempty instance ToPath DescribeDomains where toPath = const "/" instance ToQuery DescribeDomains where toQuery DescribeDomains'{..} = mconcat ["Action" =: ("DescribeDomains" :: ByteString), "Version" =: ("2013-01-01" :: ByteString), "DomainNames" =: toQuery (toQueryList "member" <$> _ddDomainNames)] -- | The result of a @DescribeDomains@ request. Contains the status of the domains specified in the request or all domains owned by the account. -- -- -- -- /See:/ 'describeDomainsResponse' smart constructor. data DescribeDomainsResponse = DescribeDomainsResponse' { _ddsrsResponseStatus :: !Int , _ddsrsDomainStatusList :: ![DomainStatus] } deriving (Eq, Read, Show, Data, Typeable, Generic) -- | Creates a value of 'DescribeDomainsResponse' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: -- -- * 'ddsrsResponseStatus' - -- | The response status code. -- -- * 'ddsrsDomainStatusList' - Undocumented member. describeDomainsResponse :: Int -- ^ 'ddsrsResponseStatus' -> DescribeDomainsResponse describeDomainsResponse pResponseStatus_ = DescribeDomainsResponse' {_ddsrsResponseStatus = pResponseStatus_, _ddsrsDomainStatusList = mempty} -- | -- | The response status code. ddsrsResponseStatus :: Lens' DescribeDomainsResponse Int ddsrsResponseStatus = lens _ddsrsResponseStatus (\ s a -> s{_ddsrsResponseStatus = a}) -- | Undocumented member. ddsrsDomainStatusList :: Lens' DescribeDomainsResponse [DomainStatus] ddsrsDomainStatusList = lens _ddsrsDomainStatusList (\ s a -> s{_ddsrsDomainStatusList = a}) . _Coerce instance NFData DescribeDomainsResponse where