amazonka-cloudsearch-1.6.0: Amazon CloudSearch SDK.

Copyright(c) 2013-2018 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.CloudSearch.DescribeDomains

Contents

Description

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&amp;q.parser=structured&amp;size=0 . For more information, see Getting Information about a Search Domain in the Amazon CloudSearch Developer Guide .

Synopsis

Creating a Request

describeDomains :: DescribeDomains #

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.

data DescribeDomains #

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.

Instances

Eq DescribeDomains # 
Data DescribeDomains # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeDomains -> c DescribeDomains #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeDomains #

toConstr :: DescribeDomains -> Constr #

dataTypeOf :: DescribeDomains -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c DescribeDomains) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeDomains) #

gmapT :: (forall b. Data b => b -> b) -> DescribeDomains -> DescribeDomains #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeDomains -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeDomains -> r #

gmapQ :: (forall d. Data d => d -> u) -> DescribeDomains -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeDomains -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeDomains -> m DescribeDomains #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeDomains -> m DescribeDomains #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeDomains -> m DescribeDomains #

Read DescribeDomains # 
Show DescribeDomains # 
Generic DescribeDomains # 
Hashable DescribeDomains # 
NFData DescribeDomains # 

Methods

rnf :: DescribeDomains -> () #

AWSRequest DescribeDomains # 
ToHeaders DescribeDomains # 
ToPath DescribeDomains # 
ToQuery DescribeDomains # 
type Rep DescribeDomains # 
type Rep DescribeDomains = D1 * (MetaData "DescribeDomains" "Network.AWS.CloudSearch.DescribeDomains" "amazonka-cloudsearch-1.6.0-JI6gv0YfBTjIduRHjHbXOm" True) (C1 * (MetaCons "DescribeDomains'" PrefixI True) (S1 * (MetaSel (Just Symbol "_ddDomainNames") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * (Maybe [Text]))))
type Rs DescribeDomains # 

Request Lenses

ddDomainNames :: Lens' DescribeDomains [Text] #

The names of the domains you want to include in the response.

Destructuring the Response

describeDomainsResponse #

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:

data DescribeDomainsResponse #

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.

Instances

Eq DescribeDomainsResponse # 
Data DescribeDomainsResponse # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeDomainsResponse -> c DescribeDomainsResponse #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeDomainsResponse #

toConstr :: DescribeDomainsResponse -> Constr #

dataTypeOf :: DescribeDomainsResponse -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c DescribeDomainsResponse) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeDomainsResponse) #

gmapT :: (forall b. Data b => b -> b) -> DescribeDomainsResponse -> DescribeDomainsResponse #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeDomainsResponse -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeDomainsResponse -> r #

gmapQ :: (forall d. Data d => d -> u) -> DescribeDomainsResponse -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeDomainsResponse -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeDomainsResponse -> m DescribeDomainsResponse #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeDomainsResponse -> m DescribeDomainsResponse #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeDomainsResponse -> m DescribeDomainsResponse #

Read DescribeDomainsResponse # 
Show DescribeDomainsResponse # 
Generic DescribeDomainsResponse # 
NFData DescribeDomainsResponse # 

Methods

rnf :: DescribeDomainsResponse -> () #

type Rep DescribeDomainsResponse # 
type Rep DescribeDomainsResponse = D1 * (MetaData "DescribeDomainsResponse" "Network.AWS.CloudSearch.DescribeDomains" "amazonka-cloudsearch-1.6.0-JI6gv0YfBTjIduRHjHbXOm" False) (C1 * (MetaCons "DescribeDomainsResponse'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_ddsrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int)) (S1 * (MetaSel (Just Symbol "_ddsrsDomainStatusList") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * [DomainStatus]))))

Response Lenses

ddsrsResponseStatus :: Lens' DescribeDomainsResponse Int #

  • - | The response status code.