Copyright	(c) 2013-2018 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)
Safe Haskell	None
Language	Haskell2010

Network.AWS.CloudSearch.DescribeDomains

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

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

Synopsis

describeDomains :: DescribeDomains
data DescribeDomains
ddDomainNames :: Lens' DescribeDomains [Text]
describeDomainsResponse :: Int -> DescribeDomainsResponse
data DescribeDomainsResponse
ddsrsResponseStatus :: Lens' DescribeDomainsResponse Int
ddsrsDomainStatusList :: Lens' DescribeDomainsResponse [DomainStatus]

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 #
Instance details Defined in Network.AWS.CloudSearch.DescribeDomains Methods (==) :: DescribeDomains -> DescribeDomains -> Bool # (/=) :: DescribeDomains -> DescribeDomains -> Bool #
Data DescribeDomains #
Instance details Defined in Network.AWS.CloudSearch.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 #
Instance details Defined in Network.AWS.CloudSearch.DescribeDomains Methods readsPrec :: Int -> ReadS DescribeDomains # readList :: ReadS [DescribeDomains] # readPrec :: ReadPrec DescribeDomains # readListPrec :: ReadPrec [DescribeDomains] #
Show DescribeDomains #
Instance details Defined in Network.AWS.CloudSearch.DescribeDomains Methods showsPrec :: Int -> DescribeDomains -> ShowS # show :: DescribeDomains -> String # showList :: [DescribeDomains] -> ShowS #
Generic DescribeDomains #
Instance details Defined in Network.AWS.CloudSearch.DescribeDomains Associated Types type Rep DescribeDomains :: * -> * # Methods from :: DescribeDomains -> Rep DescribeDomains x # to :: Rep DescribeDomains x -> DescribeDomains #
Hashable DescribeDomains #
Instance details Defined in Network.AWS.CloudSearch.DescribeDomains Methods hashWithSalt :: Int -> DescribeDomains -> Int # hash :: DescribeDomains -> Int #
AWSRequest DescribeDomains #
Instance details Defined in Network.AWS.CloudSearch.DescribeDomains Associated Types type Rs DescribeDomains :: * # Methods request :: DescribeDomains -> Request DescribeDomains # response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy DescribeDomains -> ClientResponse -> m (Response DescribeDomains) #
ToHeaders DescribeDomains #
Instance details Defined in Network.AWS.CloudSearch.DescribeDomains Methods toHeaders :: DescribeDomains -> [Header] #
ToPath DescribeDomains #
Instance details Defined in Network.AWS.CloudSearch.DescribeDomains Methods toPath :: DescribeDomains -> ByteString #
ToQuery DescribeDomains #
Instance details Defined in Network.AWS.CloudSearch.DescribeDomains Methods toQuery :: DescribeDomains -> QueryString #
NFData DescribeDomains #
Instance details Defined in Network.AWS.CloudSearch.DescribeDomains Methods rnf :: DescribeDomains -> () #
type Rep DescribeDomains #
Instance details Defined in Network.AWS.CloudSearch.DescribeDomains type Rep DescribeDomains = D1 (MetaData "DescribeDomains" "Network.AWS.CloudSearch.DescribeDomains" "amazonka-cloudsearch-1.6.0-C9KDnoOihM1BDmnzNS5XoR" True) (C1 (MetaCons "DescribeDomains'" PrefixI True) (S1 (MetaSel (Just "_ddDomainNames") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe [Text]))))
type Rs DescribeDomains #
Instance details Defined in Network.AWS.CloudSearch.DescribeDomains type Rs DescribeDomains = DescribeDomainsResponse

Request Lenses

ddDomainNames :: Lens' DescribeDomains [Text] #

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

Destructuring the Response

describeDomainsResponse #

Arguments

:: Int	`ddsrsResponseStatus`
-> 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:

ddsrsResponseStatus - -- | The response status code.
ddsrsDomainStatusList - Undocumented member.

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 #
Instance details Defined in Network.AWS.CloudSearch.DescribeDomains Methods (==) :: DescribeDomainsResponse -> DescribeDomainsResponse -> Bool # (/=) :: DescribeDomainsResponse -> DescribeDomainsResponse -> Bool #
Data DescribeDomainsResponse #
Instance details Defined in Network.AWS.CloudSearch.DescribeDomains 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 #
Instance details Defined in Network.AWS.CloudSearch.DescribeDomains Methods readsPrec :: Int -> ReadS DescribeDomainsResponse # readList :: ReadS [DescribeDomainsResponse] # readPrec :: ReadPrec DescribeDomainsResponse # readListPrec :: ReadPrec [DescribeDomainsResponse] #
Show DescribeDomainsResponse #
Instance details Defined in Network.AWS.CloudSearch.DescribeDomains Methods showsPrec :: Int -> DescribeDomainsResponse -> ShowS # show :: DescribeDomainsResponse -> String # showList :: [DescribeDomainsResponse] -> ShowS #
Generic DescribeDomainsResponse #
Instance details Defined in Network.AWS.CloudSearch.DescribeDomains Associated Types type Rep DescribeDomainsResponse :: * -> * # Methods from :: DescribeDomainsResponse -> Rep DescribeDomainsResponse x # to :: Rep DescribeDomainsResponse x -> DescribeDomainsResponse #
NFData DescribeDomainsResponse #
Instance details Defined in Network.AWS.CloudSearch.DescribeDomains Methods rnf :: DescribeDomainsResponse -> () #
type Rep DescribeDomainsResponse #
Instance details Defined in Network.AWS.CloudSearch.DescribeDomains type Rep DescribeDomainsResponse = D1 (MetaData "DescribeDomainsResponse" "Network.AWS.CloudSearch.DescribeDomains" "amazonka-cloudsearch-1.6.0-C9KDnoOihM1BDmnzNS5XoR" False) (C1 (MetaCons "DescribeDomainsResponse'" PrefixI True) (S1 (MetaSel (Just "_ddsrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int) :*: S1 (MetaSel (Just "_ddsrsDomainStatusList") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 [DomainStatus])))

Response Lenses

ddsrsResponseStatus :: Lens' DescribeDomainsResponse Int #

- | The response status code.

ddsrsDomainStatusList :: Lens' DescribeDomainsResponse [DomainStatus] #

Undocumented member.